Thank you for investing your time in contributing to our project !!! Any contribution you make will be reflected on Oxalis-NG Releases ✨.
Read our Code of Conduct to keep our community approachable and respectable. In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
To get an overview of the project, read the README file. Here are some resources to help you get started with open source contributions:
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
Before starting contributing, please make yourself aware of codebase, and also go through WIKI pages.
If you found a bug/issue, before creating issue first search if such issue already exist or not - Search in both open and closed issues. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
Scan through our existing issue to find one that interests you. You can narrow down the search using labels as filters.
As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
- Fork the repository.
-
Using GitHub Desktop:
- Getting started with GitHub Desktop will guide you through setting up Desktop.
- Once Desktop is set up, you can use it to fork the repo!
-
Using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
- Create a working branch and start with your changes!
When you're finished with the changes, create a pull request, also known as a PR - Pull Request Template
Congratulations 🎉🎉 The Oxalis Community team thanks you ✨.
Once your PR is merged, your contributions will be publicly visible on the Oxalis-NG Releases.