Line 1... |
Line 1... |
# Contributing
|
# Contributing
|
|
|
When contributing to this repository, please first discuss the change you wish to make via issue,
|
I'm always thankful for help! So if you have any questions, bug reports, ideas or if you want to give any kind of feedback, feel free
|
email, or any other method with the owners of this repository before making a change.
|
to [open a new issue](https://github.com/stnolting/neorv32/issues), start a new
|
|
[discussion on GitHub](https://github.com/stnolting/neorv32/discussions) or directly [drop me a line](mailto:stnolting@gmail.com).
|
|
|
Please note we have a [Code of Conduct](https://github.com/stnolting/neorv32/tree/master/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
|
:information_source: Please note we have a [Code of Conduct](https://github.com/stnolting/neorv32/tree/master/CODE_OF_CONDUCT.md),
|
|
please follow it in all your interactions with the project.
|
|
|
## Contributing Process
|
## Contributing Process
|
|
|
0. :star: this repository ;)
|
Here is a simple guide line if you'd like to contribute to this project:
|
|
|
|
0. :star: this repository :wink:
|
1. Check out the project's [code of conduct](https://github.com/stnolting/neorv32/tree/master/CODE_OF_CONDUCT.md)
|
1. Check out the project's [code of conduct](https://github.com/stnolting/neorv32/tree/master/CODE_OF_CONDUCT.md)
|
2. [Fork](https://github.com/stnolting/neorv32/fork) this repository and clone the fork
|
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`
|
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`
|
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!"`
|
5. Commit your modifications: `git commit -m "Awesome new feature!"`
|
6. Push to the branch: `git push origin awesome_new_feature_branch`
|
6. Push to the branch: `git push origin awesome_new_feature_branch`
|
7. Create a new [pull request](https://github.com/stnolting/neorv32/pulls)
|
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)
|