-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
39 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
Contributing | ||
============ | ||
|
||
ππ Thanks a lot for considering contributing ππ | ||
|
||
We welcome and encourage contribution. There is many way to contribute: you can | ||
write bug report, contribute code or documentation. | ||
You can also go to the [bitcraze forum](https://forum.bitcraze.io) and help others. | ||
|
||
## Reporting issues | ||
|
||
When reporting issues the more information you can supply the better. | ||
|
||
- **Information about the environment:** | ||
- What version of the the lib are you using | ||
- **What is the issue:** A clear explaination of what whas the expected behavior and what is the observed behavior can | ||
often help a lot. | ||
|
||
## Improvements request and proposal | ||
|
||
Feel free to make an issue to request a new functionality. | ||
|
||
## Contributing code/Pull-Request | ||
|
||
We welcome code contribution, this can be done by starting a pull-request. | ||
|
||
If the change is big, typically if the change span to more than one file, consider starting an issue first to discuss the improvement. | ||
This will makes it much easier to make the change fit well into the lib. | ||
|
||
There is some basic requirement for us to merge a pull request: | ||
- Describe the change | ||
- Refer to any issues it effects | ||
- Separate one pull request per functionality: if you start writing "and" in the feature description consider if it could be separated in two pull requests. | ||
- Specify if the change affects the Arduino boards on which the lib can run(ie. are you adding a board-specific functionality). | ||
|
||
In your code: | ||
- 2 spaces indentation | ||
- Make sure the coding style of your code follows the style of the file. | ||
|