neorv32/CONTRIBUTING.md

Contributing

Any kind of help is highly appreciated! So if you have any questions, bug reports, ideas or if you want to give some kind of feedback, feel free to open a new issue or start a new discussion. Also look out for issues and pull requests labeled with and ; the latter one might be a good starting point for newcomers and beginners.

Please note that we have a Code of Conduct. Please follow it in all your interactions with this project.

Contributing Process

Here is a simple guide line if you'd like to contribute code modifications to this project:

1. Fork this repository and clone the fork: git clone https://github.com/stnolting/neorv32.git
2. In your local copy, create a feature branch in your fork: git checkout -b awesome_new_feature_branch
3. Create a new remote for the upstream repo: git remote add upstream https://github.com/stnolting/neorv32
4. Commit your modifications: git commit -m "Awesome new feature!"
5. Push to the branch: git push origin awesome_new_feature_branch
6. Create a new pull request; please make sure that your feature branch is up-to-date with the project's main branch; we will review it as soon as possible
7. If you like, discuss / show-case your work on the project's discussion board

If your merge request modifies the code base in a significant way (something more than just a typo fix) please also update the version identifier (increment the least-significant number) and add an according change log entry (see CHANGELOG.md for more information).