8000 Improve CONTRIBUTING.md by per1234 · Pull Request #6357 · arduino/Arduino · GitHub
[go: up one dir, main page]
Skip to content

Improve CONTRIBUTING.md #6357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
May 7, 2019
Merged

Improve CONTRIBUTING.md #6357

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
037a672
Separate CONTRIBUTING.md into Issues and Pull Requests sections
per1234 Jun 7, 2017
1749ab7
CONTRIBUTING.md: Change format of the repositories table
per1234 Jun 7, 2017
f508261
CONTRIBUTING.md: Use list format
per1234 Jun 7, 2017
f110e37
Rewrite Issues section of CONTRIBUTING.md
per1234 Jun 7, 2017
f044f29
Rewrite Pull Requests section of CONTRIBUTING.md
per1234 Jun 7, 2017
e46a6ce
Add list of contribution options to CONTRIBUTING.md
per1234 Jun 16, 2017
acd8d43
Add Language Reference repositories to CONTRIBUTING.md
per1234 Nov 8, 2017
bc900cc
Add ArduinoCore-avr repository to CONTRIBUTING.md
per1234 Dec 10, 2017
c6e8467
Correct location to report Web Editor issues listed in CONTRIBUTING.md
per1234 Dec 29, 2017
4c9da50
Add link to CVD policy
per1234 Oct 11, 2018
5008ca7
Remove mention of Playground being a publicly editable wiki from CONT…
per1234 Apr 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
CONTRIBUTING.md: Change format of the repositories table
  • Loading branch information
@per1234
per1234 committed Mar 1, 2018
commit 1749ab7c5fb7fdea190d8bfa441ffa0da6d14911
29 changes: 16 additions & 13 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,22 @@ To report a bug or a small enhancement please use the [issue tracker](http://git
- [ ] `Your issue is not a duplicate.` So search for similar open and closed issues and pull-requests.
- [ ] `Make sure you are working on the right repository. See the table below.`

| Repositories | Projects |
|---|---|
|[Arduino](https://github.com/arduino/Arduino) | Arduino IDE, arduino.cc (but not the Arduino Playground), Library Manager |
|[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 |
|[Arduino Forum](https://github.com/arduino/forum-issues) | Issues about the Arduino Forum |
| [Libraries for Arduino IDE](https://github.com/arduino-libraries) | Changing libraries for the IDE |
| [Arduino-builder](https://github.com/arduino/arduino-builder)| |
|[Arduino Web Editor](https://github.com/arduino/arduino-create-agent) | |
|[Arduino SAMD Boards](https://github.com/arduino/ArduinoCore-samd)|Zero, MKR1000, MKRZero, etc. |
|[Arduino SAM Boards](https://github.com/arduino/ArduinoCore-sam)| Due |
|[Arduino AVR Boards toolchain (avr-gcc)](https://github.com/arduino/toolchain-avr)| |
|[Arduino's build of AVRDUDE](https://github.com/arduino/avrdude-build-script)||
|Third party repository | for third party libraries, hardware packages or sketches |
| Issue topic | Report at |
|-|-|
| Arduino IDE, Arduino AVR Boards, arduino.cc (but not the Arduino Playground), Library Manager additions | [arduino/Arduino](https://github.com/arduino/Arduino) |
| [Arduino Playground](http://playground.arduino.cc/) | This is a publicly editable wiki. Please either make the edit yourself or create a post on the [forum](http://forum.arduino.cc/index.php?board=24.0). |
| Translations for the Arduino IDE | [transifex](https://www.transifex.com/mbanzi/arduino-ide-15/) |
| Arduino Forum | [arduino/forum-issues](https://github.com/arduino/forum-issues) |
| Arduino libraries | [arduino-libraries](https://github.com/arduino-libraries) |
| arduino-builder | [arduino/arduino-builder](https://github.com/arduino/arduino-builder) |
| [Arduino Web Editor](https://create.arduino.cc/editor) | [arduino/arduino-create-agent](https://github.com/arduino/arduino-create-agent) |
| Arduino SAMD Boards (Zero, MKR1000, MKRZero, etc.) | [arduino/ArduinoCore-samd](https://github.com/arduino/ArduinoCore-samd) |
| Arduino SAM Boards (Due) | [arduino/ArduinoCore-sam](https://github.com/arduino/ArduinoCore-sam) |
| AVR Toolchain for Arduino | [arduino/toolchain-avr](https://github.com/arduino/toolchain-avr) |
| Arduino's build of AVRDUDE | [arduino/avrdude-build-script](https://github.com/arduino/avrdude-build-script) |
| 3rd party libraries, hardware, or sketches | Report issues to the author of the software, *not* Arduino. |

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps a remark like below should be good here?

When you're not sure where your issue belongs, report it at arduino/Arduino and we'll move it to where it belongs" (but remember: Only bug reports and feature requests, do not ask for help with your own code there).

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

When you're not sure where your issue belongs, report it at [arduino/Arduino](https://github.com/arduino/Arduino) and we'll move it to where it belongs (but remember: Only bug reports and feature requests, do not ask for help with your own code there).

When you have checked the previous boxes. Please consider the following points before posting the issue.

Expand Down
0