From 7ec9468b8dc9098a010d9ac1576bd024e3f2201f Mon Sep 17 00:00:00 2001 From: Rushabh Mehta Date: Fri, 6 Sep 2013 10:46:45 +0530 Subject: [PATCH] [docs] updated contributing guidelines --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f7608d48a6..4164b2b6bb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,30 @@ # Contributing to ERPNext -### Reporting issues +## Reporting issues We only accept issues that are bug reports or feature requests. Bugs must be isolated and reproducible problems. Please read the following guidelines before opening any issue. -1. **Search for existing issues.** We want to avoid duplication, and you'd help us out a lot by first checking if someone else has reported the same issue. Moreover, the issue may have already been resolved with a fix available. -1. **Share as much information as possible.** Include operating system and version, browser and version, when did you last update ERPNext, how is it customized, etc. where appropriate. Also include steps to reproduce the bug. +1. **Search for existing issues.** We want to avoid duplication, and you'd help us out a lot by first checking if someone else has reported the same issue. The issue may have already been resolved with a fix available. -### New Features +### Issues + +1. **Share as much information as possible.** Include operating system and version, browser and version, when did you last update ERPNext, how is it customized, etc. where appropriate. Also include steps to reproduce the bug. +1. Consider adding screenshots annotated with what goes wrong. +1. If you are reporting an issue from the browser, Open the Javascript Console and paste us any error messages you see. + +### Feature Requests + +1. We need as much information you can to consider a feature request. +1. Think about **how** you want us to build the feature. Consider including: + 1. Mockups (wireframes of features) + 1. Screenshots (annotated with what should change) + 1. Screenshots from other products if you want us to implement features present in other products. +1. Basically, the more you help us, the faster your request is likely to be completed. +1. A one line future request like **Implement Capacity Planning** will be closed. + +## Pull Requests + +General guidelines for sending pull requests: #### Don't Repeat Yourself (DRY) @@ -20,6 +37,10 @@ that function to accommodate your use case. DocTypes are easy to create but hard to maintain. If you find that there is a another DocType with a similar functionality, then please try and extend that functionality. For example, by adding a "type" field to classify the new type of record. +#### Don't Send Trivial Requests + +Don't send pull requests for fixing a simple typo in a code comment. + #### Tabs or spaces? Tabs!