diff options
| -rw-r--r-- | CONTRIBUTING.md | 34 | ||||
| -rw-r--r-- | HISTORY.md | 1 |
2 files changed, 35 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..94e091d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +# Contributing To Arduino Makefile + +Community made patches, localisations, bug reports, documentation and contributions are always welcome and are crucial to the success of this project. + +When contributing please ensure you follow the guidelines below so that we can keep on top of things. + +## Getting Started + +Submit a ticket for your issue, assuming one does not already exist. + +- Raise it on our [Issue Tracker](https://github.com/sudar/Arduino-Makefile/issues) +- Clearly describe the issue including steps to reproduce the bug. +- Make sure you fill in the earliest version that you know has the issue as well as the following + - Your operating system (Mac, Linux/Unix, Windows) + - Your Arduino IDE version + - Snippet of your makefile + +## Making Changes + +- Fork the repository on GitHub +- Make the changes to your forked repository +- Update the [changelog file](HISTORY.md) and add a note about your change. If possible prefix it with either Fix, Tweak or New +- When committing, reference your issue (if present) and include a note about the fix + - If possible (and if makes sense) do atomic commits + - Try to follow [this guideline](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) while choosing the git commit message +- Push the changes to your fork and submit a pull request to the 'master' branch of the this repository + +At this point you're waiting on us to merge your pull request. We'll review all pull requests, and make suggestions and changes if necessary. + +# Additional Resources + +- [General GitHub Documentation](http://help.github.com/) +- [GitHub Pull Request documentation](http://help.github.com/send-pull-requests/) +- [Guide about contributing code in GitHub](http://sudarmuthu.com/blog/contributing-to-project-hosted-in-github) @@ -17,6 +17,7 @@ I tried to give credit whenever possible. If I have missed anyone, kindly add it - New: Add option to set fuses without burning a bootloader. Fix #141 (https://github.com/sej7278) - Tweak: Don't append port details to avrdude for usbtiny. Fix #140 and #138 (https://github.com/PPvG) - Fix: Handle relative paths of bootloader file while burning bootloaders. Fix #126 and #142 (https://github.com/sej7278) +- New: Add `CONTRIBUTING.md` explaining how to contribute to the project. ### 1.0.1 (2013-09-25) - Unconditionally add -D in avrdude options. See #114 |