|
| 1 | +## Contributing guide |
| 2 | +This document serves as a checklist before contributing to this repository. It includes includes links to read up on if topics are unclear to you. |
| 3 | + |
| 4 | +This guide mainly focuses on the proper use of Git. It has some overlap with the more general information found in the [Development Policy File](https://github.com/arduino/Arduino/wiki/Development-Policy). |
| 5 | + |
| 6 | +### 1. Before using the issue tracker |
| 7 | +To report a bug or a small enhancement please use the [issue tracker](http://github.com/arduino/Arduino/issues). But check the following boxes before posting an issue: |
| 8 | + |
| 9 | +- [ ] `Your issue is NOT a question about an Arduino sketch.` Sketch questions are handled on the [Arduino Forum](http://forum.arduino.cc/). |
| 10 | +- [ ] `Check if your issue has already been resolved in the` [hourly build](http://www.arduino.cc/en/Main/Software#hourly) |
| 11 | +- [ ] `Your issue is not a duplicate.` So search for similar open and closed issues and pull-requests. |
| 12 | +- [ ] `Make sure you are working on the right repository. See the table below.` |
| 13 | + |
| 14 | +| Repositories | Projects | |
| 15 | +|---|---| |
| 16 | +|[Arduino](https://github.com/arduino/Arduino) | Arduino IDE, arduino.cc (but not the Arduino Playground), Library Manager | |
| 17 | +|[Arduino Playground](http://forum.arduino.cc/index.php?board=24.0) | This is a publicly editable wiki. Please either make the edit yourself or create a post | |
| 18 | +|[Arduino Forum](https://github.com/arduino/forum-issues) | Issues about the Arduino Forum | |
| 19 | +| [Libraries for Arduino IDE](https://github.com/arduino-libraries) | Changing libraries for the IDE | |
| 20 | +| [Arduino-builder](https://github.com/arduino/arduino-builder)| | |
| 21 | +|[Arduino Web Editor](https://github.com/arduino/arduino-create-agent) | | |
| 22 | +|[Arduino SAMD Boards](https://github.com/arduino/ArduinoCore-samd)|Zero, MKR1000, MKRZero, etc. | |
| 23 | +|[Arduino SAM Boards](https://github.com/arduino/ArduinoCore-sam)| Due | |
| 24 | +|[Arduino AVR Boards toolchain (avr-gcc)](https://github.com/arduino/toolchain-avr)| | |
| 25 | +|[Arduino's build of AVRDUDE](https://github.com/arduino/avrdude-build-script)|| |
| 26 | +|Third party repository | for third party libraries, hardware packages or sketches | |
| 27 | + |
| 28 | +### 2. Posting the issue |
| 29 | +When you have checked the previous boxes. Please consider the following points before posting the issue. |
| 30 | + |
| 31 | +- [ ] `Describe the issue based on the behaviour you were expecting` |
| 32 | +- [ ] `Post complete error messages using markdown code fencing:` [Markdown Code Fencing Example](https://guides.github.com/features/mastering-markdown/#examples) |
| 33 | +- [ ] `Provide a full set of steps necessary to reproduce the issue` |
| 34 | +- [ ] `Demonstration code should be complete, correct and the minimum amount necessary to reproduce the issue` |
| 35 | +- [ ] `Library Manager submissions: make sure your library meets all the requirements listed in the` [Library Manager FAQ](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ) |
| 36 | + |
| 37 | +### 3. Pull Requests |
| 38 | +Before starting to work on bigger topics like modifying the API or changes with backward compatibility trade-offs please discuss them in the [mailing list](https://groups.google.com/a/arduino.cc/forum/#!forum/developers) first. |
| 39 | + |
| 40 | +### 4. Commit messages |
| 41 | +An easy to read pull request will speed up the merging process. Your commit messages need to be logically separate. And containing enough information on their own. When this is done consistently your pull request will have an easy to read log of changes. |
| 42 | + |
| 43 | +Your commits need to be [atomic](https://www.freshconsulting.com/atomic-commits/) which allows the repository to remain flexible after merging. |
| 44 | + |
| 45 | +If you did not read the following 7 points before or just want to fresh up. Please read up on them on this [website](https://chris.beams.io/posts/git-commit) by Chris Beams. |
| 46 | + |
| 47 | +1. Separate subject from body with a blank line |
| 48 | +2. Limit the subject line (first line) to 50 characters |
| 49 | +3. Capitalize the subject line |
| 50 | +4. Do not end the subject line with a period `(.)` |
| 51 | +5. Use the imperative mood in the subject line. |
| 52 | +This should be in the written as giving an instruction for example "Fixed save-as bug" (it shows what the PR achieves when merging it) |
| 53 | +6. Wrap body at 72 characters |
| 54 | +7. Use the body to explain what, why and how |
| 55 | + |
| 56 | +If your pull request fixes, closes or resolves an issue please reference it in the body with the following [syntax](https://help.github.com/articles/closing-issues-via-commit-messages/). Also see the last lines of the following example. |
| 57 | + |
| 58 | +A general example with these 7 guidelines in mind is shown below (from the same website of [Chris Beams](https://chris.beams.io/posts/git-commit)): |
| 59 | +``` |
| 60 | +Summarize changes in around 50 characters or less |
| 61 | +
|
| 62 | +More detailed explanatory text, if necessary. Wrap it to about 72 |
| 63 | +characters or so. In some contexts, the first line is treated as the |
| 64 | +subject of the commit and the rest of the text as the body. The |
| 65 | +blank line separating the summary from the body is critical (unless |
| 66 | +you omit the body entirely); various tools like `log`, `shortlog` |
| 67 | +and `rebase` can get confused if you run the two together. |
| 68 | +
|
| 69 | +Explain the problem that this commit is solving. Focus on why you |
| 70 | +are making this change as opposed to how (the code explains that). |
| 71 | +Are there side effects or other unintuitive consequences of this |
| 72 | +change? Here's the place to explain them. |
| 73 | +
|
| 74 | +Further paragraphs come after blank lines. |
| 75 | +
|
| 76 | + - Bullet points are okay, too |
| 77 | +
|
| 78 | + - Typically a hyphen or asterisk is used for the bullet, preceded |
| 79 | + by a single space, with blank lines in between, but conventions |
| 80 | + vary here |
| 81 | +
|
| 82 | +If you use an issue tracker, put references to them at the bottom, |
| 83 | +like this: |
| 84 | +
|
| 85 | +Resolves: #123 |
| 86 | +See also: #456, #789 |
| 87 | +``` |
| 88 | + |
| 89 | +### 5. Rebasing pull requests |
| 90 | +When different people are working on the Arduino project simultaneously, pull requests can go stale quickly. A "stale" pull request is one that is no longer up to date with the latest merges in the project. It needs to be updated before it can be merged. |
| 91 | + |
| 92 | +Most often pull requests become stale when merge conflicts occur. This happens when two pull requests both modify similar lines in the same file and one gets merged, the unmerged request will now have a merge conflict and needs updating. |
| 93 | + |
| 94 | +When your pull request is stale, you will need to rebase your branch on the current master branch before you can merge it without conflicts. |
| 95 | + |
| 96 | +More information about rebasing can be found at the repository of [edX](https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request). |
| 97 | + |
| 98 | +### 6. Merged! |
| 99 | +When your pull request is merged please update the documentation if the changes require it: |
| 100 | + |
| 101 | +- [ ] Edit appropiate [Wiki pages](https://github.com/arduino/Arduino/wiki/_pages) |
| 102 | +- [ ] Submit an [issue report](https://github.com/arduino/Arduino/issues/new) requesting changes to the [arduino.cc reference pages](https://www.arduino.cc/en/Reference/HomePage) |
0 commit comments