diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d19e57..cb3bfde 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,38 +14,15 @@ If you want to report an *issue* with Pico's core, please create a new [Issue](h Before creating a [new Issue on GitHub](https://github.com/picocms/Pico/issues/new), please make sure the problem wasn't reported yet using [GitHubs search engine](https://github.com/picocms/Pico/search?type=Issues). Please describe your issue as clear as possible and always include steps to reproduce the problem. -This is an example of what information to include with your issue. - - Version - - Operating System and version - - Pico Version - - other installed software, plugins, if applicable - - hardware information, if applicable - - Bug Description - - A concise description of what the problem is. Pure description, no narrative or conversational language. - - Severity - - Trivial, Minor, Major, or Catastrophic - - Steps to Reproduce - - Step by step instructions on how to reproduce this bug. - - Do not assume anything, the more detailed your list of instructions, the easier it is for the developer to track down the problem! - - Actual Behavior - - Type what happens when you follow the instructions. This is the manifestation of the bug. - - Expected Behavior - - Type what you expected to happen when you followed the instructions. - - This is important, because you may have misunderstood something or missed a step, - and knowing what you expected to see will help the developer recognize that. - - Troubleshooting/Testing Steps Attempted - - Describe anything you did to try to fix it on your own. - - Workaround - - If you found a way to make the program work in spite of the bug, describe how you did it here. +This is an example of what type of information to include with your issue. +- Pico Version +- Installed plugins, if applicable +- Bug Description +- Steps to Reproduce +- Actual/Expected Behavior +- Troubleshooting/Testing Steps Attempted +- Workarounds? Contributing code -----------------