Skip to content

Commit 2d2eaac

Browse files
Merge pull request #121 from Anjali0909/master
Create CONTRIBUTIONS.md
2 parents 09bd0bb + 1d973b0 commit 2d2eaac

1 file changed

Lines changed: 39 additions & 0 deletions

File tree

CONTRIBUTIONS.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Contributing to nctoolkit
2+
3+
🎉 Thank you for your interest in contributing to nctoolkit! Your efforts help improve this tool for the entire community. Whether you're fixing bugs, adding new features, or enhancing documentation, your contributions are invaluable. Let's make this project even better together! 🎉
4+
5+
How to Contribute
6+
7+
To contribute, please follow these steps:
8+
9+
1. Fork the Repository
10+
Click the "Fork" button at the top right of this page to create a copy of this repository under your GitHub account.
11+
12+
2. Clone and Set Up the Repository
13+
After forking, open your terminal, clone the repository to your local machine, and navigate into the project directory:
14+
git clone https://github.com/your-username/nctoolkit.git
15+
cd nctoolkit
16+
17+
3. Create a New Branch
18+
Create a new branch for your contribution to keep your changes organized and separated from the main codebase:
19+
git checkout -b feature/your-feature-name
20+
21+
4. Make Your Changes
22+
Add your feature, fix bugs, or improve documentation. Be sure to:
23+
Keep your changes focused on a single feature or fix for easier review.
24+
Test your modifications to ensure they work as intended.
25+
Follow any coding style guidelines noted in the project.
26+
27+
5. Commit Your Changes
28+
When you’re ready, stage and commit your changes with a clear, descriptive commit message:
29+
git add .
30+
git commit -m "Add detailed description of your changes here"
31+
32+
6. Push to Your Fork
33+
Push your branch to your GitHub repository:
34+
git push origin feature/your-feature-name
35+
36+
7. Submit a Pull Request (PR)
37+
Go to the original nctoolkit repository on GitHub.
38+
Click the "New Pull Request" button and select your branch.
39+
Include a detailed description of your changes to help reviewers understand your contribution.

0 commit comments

Comments
 (0)