diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0ff3e95637..037c1a7e3a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,11 @@ If you are reading this page, you are possibly interested in contributing to our # How to make a good bug report... -(FIXME - someone please add) +* Make sure your bug is not a support issue. Support issues should go to [the APM forums](http://ardupilot.com/forum/). Support issues with logs attached should generally go to the "Log files, Tuning, and Analysis of Log files" section. If you're not sure you have a bug, you should seek support first. +* Search for your bug, make sure it is not already reported. If it is already reported, make a comment on that issue. +* Write a clear summary. Be specific about what component of the software you are writing about, and follow the convention: "Copter: blah blah blah" +* Write a clear description, with **particularly clear steps** to reproduce the problem. Include logs that display the bug. +* The majority of issues open now are good or acceptable by these guidelines. Please refer to them for examples. # Submitting patches @@ -24,4 +28,4 @@ To contribute, you can send a pull request on Github. You can also join the [development discussion on Google Groups](https://groups.google.com/forum/?fromgroups#!forum/drones-discuss). Note that the Google Groups mailing lists are NOT for user tech support, -and are moderated for new users to prevent off-topic discussion. \ No newline at end of file +and are moderated for new users to prevent off-topic discussion.