mirror of
https://github.com/frappe/erpnext.git
synced 2026-05-07 15:25:19 +00:00
8efdab7e96
Updated the contributing guidelines for clarity and consistency. Improved language and formatting for better readability.
71 lines
2.4 KiB
Markdown
71 lines
2.4 KiB
Markdown
### Introduction (For First-Time Contributors)
|
|
|
|
Thank you for your interest in raising an issue with ERPNext. An issue can be either a bug report or a feature request.
|
|
|
|
By reporting bugs, you contribute directly to improving ERPNext. Bug reports help developers identify and fix issues quickly before they affect more users.
|
|
|
|
Feature requests are also valuable. They help shape the future of the product by introducing new ideas and improvements based on real-world use cases.
|
|
|
|
When raising an issue, keep in mind that developers do not have access to your environment. Therefore, provide as much relevant information as possible.
|
|
|
|
If you are suggesting a feature, clearly describe what you expect and how it should behave.
|
|
|
|
> ⚠️ The issue tracker is not the right place for general questions or discussions.
|
|
> Please use the forum instead: https://discuss.frappe.io/c/erpnext/6
|
|
|
|
---
|
|
|
|
### Reply and Closing Policy
|
|
|
|
If your issue is unclear or does not meet the guidelines, it may be closed.
|
|
|
|
If that happens, please provide the requested information and reopen the issue.
|
|
|
|
---
|
|
|
|
### General Issue Guidelines
|
|
|
|
1. **Search existing issues:**
|
|
Before creating a new issue, check if it already exists. You can support existing issues with a 👍 or contribute additional details or mockups.
|
|
|
|
2. **Report issues separately:**
|
|
Do not combine multiple unrelated issues into a single report.
|
|
|
|
3. **Be concise:**
|
|
Avoid long explanations. Use bullet points and screenshots where possible.
|
|
|
|
---
|
|
|
|
### Bug Report Guidelines
|
|
|
|
1. **Steps to reproduce:**
|
|
Clearly list the steps required to reproduce the issue. If the issue cannot be reproduced, it cannot be fixed.
|
|
|
|
2. **Version number:**
|
|
Include the ERPNext version. The issue may already be fixed in a newer release.
|
|
|
|
3. **Clear title:**
|
|
Use a descriptive title (e.g., "Unable to submit Purchase Order without Basic Rate" instead of "Cannot submit").
|
|
|
|
4. **Screenshots:**
|
|
Add screenshots or screen recordings (e.g., `.gif`) to illustrate the issue.
|
|
|
|
---
|
|
|
|
### Feature Request Guidelines
|
|
|
|
1. **Clarity:**
|
|
Clearly describe the expected behavior. Avoid vague statements.
|
|
|
|
2. **Proposed solution:**
|
|
Suggest how the feature should work.
|
|
|
|
3. **Mockups:**
|
|
Provide mockups or examples whenever possible.
|
|
|
|
---
|
|
|
|
### What if my issue is closed?
|
|
|
|
Don't worry. Review the feedback, provide the required information, and reopen the issue.
|