diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 71c85a7..c596286 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -184,8 +184,18 @@ When working on a pull request for patch-hub, you will often re-evaluate somethi Rewriting commits helps ensure the pull request shows only the final, intended changes. This improves reviewability and long-term maintainability by avoiding a noisy trail of intermediate fixes, making it easier for reviewers to understand the final result without tracking every small adjustment. It also benefits long-term maintainability by keeping the git history clean and meaningful, simplifying future debugging, version tracking, and change audits across the project’s lifecycle. +### Issues Tracking + +It’s recommended that each Pull Request reference the issue it addresses (e.g., Closes #123 or Resolves #123). If there isn’t an existing issue, consider creating one before opening the PR. + +Following this practice helps improve project organization and traceability, makes it easier for maintainers and contributors to assess proposed changes, and enables GitHub’s automatic linking between issues and PRs. This also clarifies that work is already underway, helping to prevent duplicated efforts—even before the PR is reviewed or merged. + ## Issue Reporting +We suggest that all bugs, feature requests, and proposed changes be reported as issues. Contributors should create an issue describing the problem or proposal before starting work on a Pull Request. + +This approach ensures visibility, provides maintainers and contributors the opportunity to discuss the need and scope of the change, and helps others stay informed about ongoing work. + Use the preconfigured templates on GitHub to report issues and request features. If none of these fit your issue, you can use the "Blank" option. ## License