Table of Contents generated with DocToc
Community made patches, localizations, 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.
Submit a ticket for your issue, assuming one does not already exist.
- Raise it on our Issue Tracker
- 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
- Your board, sensors and actuators
First thing first, read carefully our [rules and tools](https://github.com/WeAreLeka/rules-and-tools).
Then:
- Fork the repository on GitHub
- Create a new branch for the current story you are working on. Using
masteris bad practice - Make changes to your forked repository
- If you are adding or changing the behavior of any variable, method or class, then update the corresponding documentation in the respective files as well
- When committing, reference your issue (if present) and include a note about the fix
- If possible (and if it makes sense) do atomic commits
- Try to follow this guideline while choosing the git commit message
- Push the changes to your fork and submit a pull request to the
devbranch of the this repository
At this point you're waiting for us to merge your pull request. We'll review all pull requests, and make suggestions and changes if necessary.