-
Notifications
You must be signed in to change notification settings - Fork 1
GitHub Issues
Dependency Assistant uses GitHub for tracking issues and pull requests.
Issue titles are used when release notes are generated, so they should describe the user-visible change or problem clearly. The preferred title form depends on the type of issue. The following guidelines apply to both issues and pull requests. If necessary, update the title while working on the issue or pull request.
The title should describe the problem, rather than the solution. This makes it easier for users to find an issue when they check whether a problem has already been reported or fixed.
The title should describe the project and the new version, for example "Upgrade to Gradle 9.4.1".
Tasks usually describe internal work. The title should describe the work that needs to be done.
If questions arrive, add the for: stackoverflow label and close the issue with the following comment:
Thanks for getting in touch. This question is better suited to [Stack Overflow](https://stackoverflow.com/). As mentioned in [the guidelines for contributing](https://github.com/mp911de/dependency-assistant/blob/main/CONTRIBUTING.adoc#using-github-issues), we use GitHub issues for bugs and enhancements. Feel free to update this issue with a link to the re-posted question so that other people can find it, or add more details if this is a bug.
Maintainers may edit issues to make reports easier to read and triage. This is useful even when the issue is being closed.
Edits may correct grammar, spelling, or markup. For such edits, the following comment can be added:
I've edited your comment to improve the formatting. The [Mastering Markdown guide](https://guides.github.com/features/mastering-markdown/) may be useful for future reports.
We use issue labels extensively for triaged issues. Our labels are divided into four categories:
-
waiting-for-triage: On new issues/PRs so they can be addressed by the team. -
waiting-for-feedback: Used on issues/PRs when a team member asks for additional information from the requester. -
feedback-provided: Added once necessary feedback is provided by the requester. -
feedback-reminder: Added if feedback is not provided within 7 days. If no feedback is provided within 2 weeks, the issue is closed. -
blocked: Used on issues/PRs that are dependent on other issues being done. -
declined: Used on PRs that cannot be merged. -
duplicate: Used on issues/PRs if a similar issue/PR is open. -
invalid: Used on issues that are not reproducible. -
on-hold: Used on issues/PRs that shouldn’t be done now and need some more thought. -
ideal-for-contribution: Used for issues that are suitable for PRs.
-
external-project: Added on issues that correspond to a different project and should be raised there. -
stackoverflow: Added on issues that are questions and not bug reports or enhancement requests. -
team-attention: Added on issues to gather input from other team members.
-
bug: Added on issues/PRs that demonstrate incorrect/unexpected behavior. -
task: Added on issues that do not affect user-facing behavior. These are usually internal changes. -
documentation: Added on issues/PRs that add documentation or fix existing docs. -
enhancement: Added on issues/PRs that improve existing functionality. -
regression: Added on issues/PRs that indicate breaking functionality in a previous release. -
blocker: Added on issues/PRs that block the next release. -
dependency-upgrade: Added on issues/PRs that involve upgrading to a new version for a dependency.