Skip to content

docs: contribution: tracking issues and pull requests #162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
JGBSouza wants to merge 2 commits into from
Closed

docs: contribution: tracking issues and pull requests #162

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8addf79
add: documentation: contribution: add issue tracking subsection
JGBSouza Oct 6, 2025
2770914
add: documentation: contribution: add more context on issue reporting
JGBSouza Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down