Skip to content

Commit c0d7b28

Browse files
committed
Added LICENSE, CONTRIBUTING.md
1 parent c17bf9b commit c0d7b28

File tree

3 files changed

+48
-7
lines changed

3 files changed

+48
-7
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contribution Guide
2+
We want to make contributing to this repo as easy and transparent as possible.
3+
4+
So let's go:
5+
6+
1. **Pushing directly to main branch isn't allowed.** Before contributing, make sure you are creating a new branch and making changes there. The branch name should be in this format:
7+
**`Feature/Bug_fix-Title_of_the_feature_or_bug_fix`**\
8+
For example: `Feature-Added_Custom_Nodes`, `Bug_fix-Workflow_Node_fix`. These are some valid branching names which would help us understand your contributions better.
9+
10+
2. Add meaningful descriptions in your PRs to get a clear idea about the changes you are making.
11+
12+
3. We welcome any type of contribution(s), but any contribution(s) you make will be under the MIT software license!
13+
14+
4. Consider using Nodejs version `16` to avoid any further and existing dependency issues.
15+
16+
5. When submitting a bug, try to include a detailed description including the situation when it occurrs, the files or part of code causing it (if able to find), etc.
17+
18+
19+
20+
### Your Ideas are always welcomed! 💡
21+
22+

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Syngenta Group Co. Ltd.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Built using `Reactjs`, `Redux`, and `Typescript`.
1818
<br />
1919

2020
## How to use 📝
21-
1. Go to **https://syngenta.github.io/circleci-config-visualizer** :
21+
1. Go to **https://syngenta.github.io/circleci-config-visualizer**
2222

2323
2. Click on **Upload** button and choose your config file to visualize:
2424

@@ -63,11 +63,9 @@ my-app/
6363
<br />
6464

6565
## Contributing 📌
66-
**Pushing directly to main branch isn't allowed.** Before contributing, make sure you are creating a new branch and making changes there. The branch name should be in this format:
67-
**`Feature/Bug_fix-Title_of_the_feature_or_bug_fix`**
66+
See **[CONTRIBUTING.md](./CONTRIBUTING.md)** file for understanding how to contribute.
6867

69-
For example: `Feature-Added_Custom_Nodes`, `Bug_fix-Fixed_Workflow_Node_content_overflow`. These are some valid branching names which would help us understand your contributions better.
70-
71-
Also, add meaningful descriptions in your PRs to get a clear idea about the changes you are making.
68+
<br />
7269

73-
**Your Ideas are always welcomed!** 💡
70+
## License 🔐
71+
This project is licensed under the MIT License. See the **[LICENSE](./LICENSE)** file for more details.

0 commit comments

Comments
 (0)