Skip to content

Commit

Permalink
update contributing info, and add contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MicrocontrollersDev authored Sep 23, 2024
1 parent 3e379c8 commit 6250d6a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
9 changes: 9 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Looking to contribute something to the project?

* Please make all your changes in a [feature/topic branch instead of main](https://jmeridth.com/posts/do-not-issue-pull-requests-from-your-master-branch)
* Make sure that the option that lets us make changes to your pull request is enabled
* Follow the style that everything else is using in that specific list or follow the general style in other lists if creating a new one
* If you are going to update/add a mod, try to change/add it on every list where applicable
* We reserve the right to cherrypick changes and add them ourselves (with due credit to you)
* Add your name to credits in alphabetical order in edited lists and in contributors.md, even for the tiniest of change
* Preferably link to your GitHub account, though you may link to something else if you wish
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ If you found any of these guides useful, please considering starring this reposi

Looking to contribute something to the project?

* Please make all your changes in a feature branch instead of main
* Please make all your changes in a [feature/topic branch instead of main](https://jmeridth.com/posts/do-not-issue-pull-requests-from-your-master-branch)
* Make sure that the option that lets us make changes to your pull request is enabled
* Follow the style that everything else is using in that specific list or follow the general style in other lists if creating a new one
* If you are going to update/add a mod, make sure that you change/add it on every list where applicable
* If you are going to update/add a mod, try to change/add it on every list where applicable
* We reserve the right to cherrypick changes and add them ourselves (with due credit to you)
* Add your name to credits in alphabetical order in edited lists and in contributors.md, even for the tiniest of change
* Preferably link to your GitHub account, though you may link to something else if you wish

0 comments on commit 6250d6a

Please sign in to comment.