27 lines
1.8 KiB
Markdown
27 lines
1.8 KiB
Markdown
|
# 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](https://github.com/stnolting/neorv32/issues), start a new [discussion](https://github.com/stnolting/neorv32/discussions)
|
||
|
|
or have a chat on out [gitter](https://gitter.im/neorv32/community) channel.
|
||
|
|
Also look out for issues and pull requests labeled with
|
||
|
|
[](https://github.com/stnolting/neorv32/labels/help%20wanted) and
|
||
|
|
[](https://github.com/stnolting/neorv32/labels/good%20first%20issue)
|
||
|
|
(links!); the latter one might be a good starting point for newcomers and beginners.
|
||
|
|
|
||
|
|
Please note we have a [Code of Conduct](https://github.com/stnolting/neorv32/tree/main/CODE_OF_CONDUCT.md),
|
||
|
|
please follow it in all your interactions with the project.
|
||
|
|
|
||
|
|
## Contributing Process
|
||
|
|
|
||
|
|
Here is a simple guide line if you'd like to contribute code modifications to this project:
|
||
|
|
|
||
|
|
1. Check out the project's [code of conduct](https://github.com/stnolting/neorv32/tree/main/CODE_OF_CONDUCT.md)
|
||
|
|
2. [Fork](https://github.com/stnolting/neorv32/fork) this repository and clone the fork
|
||
|
|
3. Create a feature branch in your fork: `git checkout -b awesome_new_feature_branch`
|
||
|
|
4. Create a new remote for the upstream repo: `git remote add upstream https://github.com/stnolting/neorv32`
|
||
|
|
5. Commit your modifications: `git commit -m "Awesome new feature!"`
|
||
|
|
6. Push to the branch: `git push origin awesome_new_feature_branch`
|
||
|
|
7. Create a new [pull request](https://github.com/stnolting/neorv32/pulls)
|
||
|
|
8. If you like, discuss on the project's [discussion board](https://github.com/stnolting/neorv32/discussions)
|
||
|
|
or have a chat on our [gitter](https://gitter.im/neorv32/community) channel.
|