Skip to content

Latest commit

 

History

History
77 lines (45 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

77 lines (45 loc) · 2.64 KB
Raw

Contributing to Nexca 🚀

Welcome to Nexca! We appreciate your interest in contributing to our project. Whether you're new to open-source or a seasoned developer, follow these steps to contribute to Nexca. Let's make something awesome together!

1. Explore the Repository 🧭

Start by visiting the Nexca repository. Look through the README, documentation, and open issues to get familiar with the project. You'll find areas where we need help, such as new features, bug fixes, or improving documentation.

2. Choose an Issue 🎯

Once you're familiar with the project, go to the Issues tab and pick something you want to work on. Issues are labeled to help you identify the type of contribution:

  • 🐛 Bug fixes
  • 💡 New feature ideas
  • 📄 Documentation improvements

Feel free to ask questions on the issue if you need clarification. The maintainers are happy to guide you!

3. Fork the Repository 🍴

Next, fork the Nexca repo to your GitHub account:

  1. Click the Fork button in the top-right corner of the repository.

  2. Clone your fork to your local machine:

    git clone https://github.com/YOUR-USERNAME/Nexca.git

4. Create a New Branch 🌿

To start working on the issue, create a new branch in your local repo. This keeps your changes organized and separate from the main branch:

git checkout -b issue-name

Be sure to name your branch something meaningful, like fix-bug-#123 or add-feature-xyz.

5. Make Your Changes 💻

Now, you're ready to code! Solve the issue, add tests if necessary, and ensure your code follows the project's guidelines.

6. Commit Your Changes 🔐

Once you're happy with your work, commit your changes:

git add .
git commit -m "Fixed bug #123 by improving X"

7. Push to Your Fork 🚢

Push your branch to your GitHub fork:

git push origin issue-name

8. Open a Pull Request (PR) 🔄

Go back to the original Nexca repository on GitHub and click the Compare & pull request button. Fill out the PR description, linking to the issue you're solving, and submit it for review.

9. Review and Collaborate 📝

Once your PR is open, the maintainers will review it. They may ask for changes or provide feedback. Don't hesitate to engage in the conversation and make any requested updates.

10. Merge and Celebrate 🎉

After approval, your changes will be merged into the main branch. Congrats, you're now a contributor to Nexca! 🎊

Happy coding, and thank you for helping Nexca grow! 😊

For more information, check out our Nexca repository.