Shiloh/brotherton-erpnext
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
41d126586e
brotherton-erpnext/CONTRIBUTING.md
Rushabh Mehta 881a47f5c7 [minor] moved developer mode to wn
2013-09-06 12:42:54 +05:30

2.2 KiB
Raw Blame History

Contributing to ERPNext

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. The issue may have already been resolved with a fix available.

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.
  2. Consider adding screenshots annotated with what goes wrong.
  3. 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.
  2. Think about how you want us to build the feature. Consider including:
    1. Mockups (wireframes of features)
    2. Screenshots (annotated with what should change)
    3. Screenshots from other products if you want us to implement features present in other products.
  3. Basically, the more you help us, the faster your request is likely to be completed.
  4. A one line feature request like Implement Capacity Planning will be closed.

Pull Requests

General guidelines for sending pull requests:

Don't Repeat Yourself (DRY)

We believe that the most effective way to manage a product like this is to ensure that there is minimum repetition of code. So before contributing a function, please make sure that such a feature or function does not exist else where. If it does, the try and extend that function to accommodate your use case.

Don't create new DocTypes Unless Absolutely Necessary

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!

Copyright

Please see README.md