CalvinBackup/erpnext
1
0
Fork 0
mirror of https://github.com/frappe/erpnext.git synced 2026-02-12 17:23:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated Issue Guidelines (markdown)

Rushabh Mehta
2017-04-28 16:05:23 +05:30
parent e2d3da2caf
commit 0323bdf7bc
1 changed files with 6 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
Issue-Guidelines.md

@@ -12,11 +12,16 @@ The Issue list is not the right place to ask a question or start a general discu
If your issue is not clear or does not meet the guidelines, then it will be closed. If it is closed, please supply the information asked and re-open it.
### General Issue Guidelines
1. **Search existing Issues:** Before raising a Issue, search if it has been raised before. Maybe add a 👍 or give additional help by creating a mockup if it is not already created.
1. **Report each issue separately:** Don't club multiple, unreleated issues in one note.
1. **Brief:** Please don't include long explanations. Use screenshots and bullet points instead of descriptive paragraphs.
### Bug Report Guidelines
1. **Steps to Reproduce:** The bug report must have a list of steps needed to reproduce a bug. If we cannot reproduce it, then we cannot solve it.
1. **Version Number:** Please add the version number in your report. Often a bug is fixed in the latest version
1. **Search existing Issues:** Before raising a new bug report, search if it has been raised before.
1. **Clear Title:** Add a clear subject to your bug report like "Unable to submit Purchase Order without Basic Rate" instead of just "Cannot Submit"
1. **Screenshots:** Screenshots are a great way of communicating the issues. Try adding annotations or using LiceCAP to take a screencast in `gif`.
@@ -25,14 +30,7 @@ If your issue is not clear or does not meet the guidelines, then it will be clos
1. **Clarity:** Clearly specify how do you want the feature to behave. Don't just say "I would like multiple PDF formats", say that "Ability to add multiple print formats for customers with different languages".
1. **Solution:** Try and identify how the feature should look like.
1. **Mockups:** Mockups are a great way to explain your requirement.
1. **Brief:** Please don't include long explanations, because no one has the time to read this. Please use screenshots and bullet points instead of descriptive paragraphs.
1. **Search existing Features:** Before raising a new feature request, search if it has been raised before. Maybe add a 👍 or give additional help by creating a mockup if it is not already created.
### What if my Issue is closed
Don't worry, take the feedback, supply the correct information and re-open it!
###