From 4e30b84d88531a873b75b840f20f8e2bc99d77e0 Mon Sep 17 00:00:00 2001 From: Anand Doshi Date: Tue, 19 Apr 2016 13:13:08 +0530 Subject: [PATCH] [fix] templates for pull request and issues --- .github/ISSUE_TEMPLATE.md | 40 +++++++++++++++++--------------- .github/PULL_REQUEST_TEMPLATE.md | 22 +++++++----------- 2 files changed, 30 insertions(+), 32 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 7a7a09f0a7..fdc30d25aa 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,27 +1,29 @@ +### Issue Description -##### If you are having technical problems, or have a query regarding ERPNext, make a post on our [Discussion Forum](https://discuss.erpnext.com) instead +Description... -## 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. +### Checklist -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. -1. **Report each issue separately:** Don't club multiple, unreleated issues in one note. -1. **Mention the version number:** Please mention the application, browser and platform version numbers. +- [ ] This is a bug report / feature request and not just a problem I am facing. + (Go to https://discuss.erpnext.com for help) +- [ ] I have searched https://github.com/frappe/erpnext/issues and didn't find a similar issue +- [ ] I have mentioned steps to reproduce the issue +- [ ] I have added screenshots / video / mockups +- [ ] I have not edited the code of Frappe and ERPNext +- [ ] I have mentioned a python error traceback or javascript error [optional] -### 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. **Include Screenshots if possible:** Consider adding screenshots annotated with what goes wrong. -1. **Find and post the trace for bugs:** If you are reporting an issue from the browser, Open the Javascript Console and paste us any error messages you see. -1. **Security Issues:** If you are reporting a security issue, please send a private email to . +### Specs -### Feature Requests +- ERPNext version: +- Frappe version: +- Operating System: +- Browser: +- Language: -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 feature request like **Implement Capacity Planning** will be closed. \ No newline at end of file +--- + +> **Note:** If you are reporting a security issue, please send a private email to diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3fd3c9d38d..abb0e23685 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,18 +1,14 @@ -## Pull Requests +### Pull Request Description -General guidelines for sending pull requests: +Describe your pull request here with screenshots. Optionally, link the issue that this pull request fixes. +--- -#### Purpose +### Checklist -Explain the purpose of your Pull Request in the most detail possible. Add screenshots and relevant links. -A simple breakdown of the code is also useful. +- [ ] Documentation +- [ ] Front-end Testing +- [ ] Test Cases +- [ ] Blog Post / Help +- [ ] Awesome! We are good for merging. -#### References to an issue - -If your Pull Request is a solution to an issue, make sure to refer it - - -*** - -Github has a [pretty great](https://github.com/blog/1943-how-to-write-the-perfect-pull-request) guide for making the perfect Pull Request \ No newline at end of file