@@ -1,12 +1,12 @@ | |||
### Introduction (first timers) | |||
Thank you for your interest in raising an Issue with ERPNext. An Issue could mean a bug report or a request for a missing feature. By raising a bug report, you are contributing to the development of ERPNext and this is the first step of participating in the community. Bug reports are very helpful for developers as they quickly fix the issue before other users start facing it. | |||
Thank you for your interest in raising an Issue with the Frappe Framework. An Issue could mean a bug report or a request for a missing feature. By raising a bug report, you are contributing to the development of the Frappe Framework and this is the first step of participating in the community. Bug reports are very helpful for developers as they quickly fix the issue before other users start facing it. | |||
Feature requests are also a great way to take the product forward. New ideas can come in any user scenario and the issue list also acts a roadmap of future features. | |||
When you are raising an Issue, you should keep a few things in mind. Remember that the developer does not have access to your machine so you must give all the information you can while raising an Issue. If you are suggesting a feature, you should be very clear about what you want. | |||
The Issue list is not the right place to ask a question or start a general discussion. If you want to do that , then the right place is the forum [https://discuss.erpnext.com](https://discuss.erpnext.com). | |||
The Issue list is not the right place to ask a question or start a general discussion. If you want to do that , then the right place is the forum [https://discuss.frappe.io](https://discuss.frappe.io). | |||
### Reply and Closing Policy | |||
@@ -15,8 +15,8 @@ If your issue is not clear or does not meet the guidelines, then it will be clos | |||
### 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. | |||
2. **Report each issue separately:** Don't club multiple, unreleated issues in one note. | |||
3. **Brief:** Please don't include long explanations. Use screenshots and bullet points instead of descriptive paragraphs. | |||
### Bug Report Guidelines | |||
@@ -0,0 +1,47 @@ | |||
--- | |||
name: Bug report | |||
about: Report a bug encountered while using the Frappe Framework | |||
--- | |||
<!-- | |||
Welcome to the Frappe Framework issue tracker! Before creating an issue, please heed the following: | |||
1. This tracker should only be used to report bugs and request features / enhancements to Frappe | |||
- For questions and general support, use https://discuss.frappe.io | |||
- For documentation issues, refer to https://frappe.io/docs/user/en or the developer cheetsheet https://github.com/frappe/frappe/wiki/Developer-Cheatsheet | |||
2. Use the search function before creating a new issue. Duplicates will be closed and directed to | |||
the original discussion. | |||
3. When making a bug report, make sure you provide all required information. The easier it is for | |||
maintainers to reproduce, the faster it'll be fixed. | |||
4. If you think you know what the reason for the bug is, share it with us. Maybe put in a PR 😉 | |||
--> | |||
## Description of the issue | |||
## Context information (for bug reports) | |||
**Output of `bench version`** | |||
``` | |||
(paste here) | |||
``` | |||
## Steps to reproduce the issue | |||
1. | |||
2. | |||
3. | |||
### Observed result | |||
### Expected result | |||
### Stacktrace / full error message | |||
``` | |||
(paste here) | |||
``` | |||
## Additional information | |||
OS version / distribution, `Frappe` install method, etc. |
@@ -0,0 +1,28 @@ | |||
--- | |||
name: Feature request | |||
about: Suggest an idea to improve Frappe | |||
--- | |||
<!-- | |||
Welcome to the Frappe Framework issue tracker! Before creating an issue, please heed the following: | |||
1. This tracker should only be used to report bugs and request features / enhancements to Frappe | |||
- For questions and general support, refer to https://discuss.frappe.io | |||
- For documentation issues, use https://frappe.io/docs/user/en or the developer cheetsheet https://github.com/frappe/frappe/wiki/Developer-Cheatsheet | |||
2. Use the search function before creating a new issue. Duplicates will be closed and directed to | |||
the original discussion. | |||
3. When making a feature request, make sure to be as verbose as possible. The better you convey your message, the greater the drive to make it happen. | |||
--> | |||
**Is your feature request related to a problem? Please describe.** | |||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | |||
**Describe the solution you'd like** | |||
A clear and concise description of what you want to happen. | |||
**Describe alternatives you've considered** | |||
A clear and concise description of any alternative solutions or features you've considered. | |||
**Additional context** | |||
Add any other context or screenshots about the feature request here. |
@@ -0,0 +1,19 @@ | |||
--- | |||
name: Question about using Frappe/Frappe Apps | |||
about: This is not the appropriate channel | |||
--- | |||
Please post on our forums: | |||
for questions about using the `Frappe Framework`: https://discuss.frappe.io | |||
for questions about using `ERPNext`: https://discuss.erpnext.com | |||
for questions about using `bench`, probably the best place to start is the [bench repo](https://github.com/frappe/bench) | |||
For documentation issues, use the [Frappe Framework Documentation](https://frappe.io/docs/user/en) or the [developer cheetsheet](https://github.com/frappe/frappe/wiki/Developer-Cheatsheet) | |||
For a slightly outdated yet informative developer guide: https://www.youtube.com/playlist?list=PL3lFfCEoMxvzHtsZHFJ4T3n5yMM3nGJ1W | |||
> **Posts that are not bug reports or feature requests will not be addressed on this issue tracker.** |
@@ -1 +1,33 @@ | |||
Please read the [Pull Request Checklist](https://github.com/frappe/erpnext/wiki/Pull-Request-Checklist) to ensure you have everything that is needed to get your contribution merged. | |||
<!-- | |||
Some key notes before you open a PR: | |||
1. Select which branch should this PR be merged in? | |||
2. PR name follows [convention](http://karma-runner.github.io/4.0/dev/git-commit-msg.html) | |||
3. All tests pass locally, UI and Unit tests | |||
4. All business logic and validations must be on the server-side | |||
5. Update necessary Documentation | |||
6. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes | |||
Also, if you're new here | |||
- Documentation Guidelines => https://github.com/frappe/erpnext/wiki/Updating-Documentation | |||
- Contribution Guide => https://github.com/frappe/frappe/blob/develop/.github/CONTRIBUTING.md | |||
- Pull Request Checklist => https://github.com/frappe/erpnext/wiki/Pull-Request-Checklist | |||
--> | |||
> Please provide enough information so that others can review your pull request: | |||
<!-- You can skip this if you're fixing a typo or updating existing documentation --> | |||
> Explain the **details** for making this change. What existing problem does the pull request solve? | |||
<!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. --> | |||
> Screenshots/GIFs | |||
<!-- Add images/recordings to better visualize the change: expected/current behviour --> |