Skip to content
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.

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

repo: add Tracking Issue issue template #182

Merged
merged 3 commits into from
Jun 20, 2024

Conversation

hinto-janai
Copy link
Contributor

This adds .github/ISSUE_TEMPLATE/tracking_issue.md and fixes some formatting in other templates.

The purpose of this is to track wider efforts that may contain multiple PRs and/or are generally spread out. These don't usually contain the why, but if they do, they are brief. These contain no implementation detail or the how, as those are for the issues/PRs that are being tracked.

For example:

A big difference between this and a proposal is that tracking issues already have consensus, i.e. the thing in question is already decided on. The what/why/where is already answered, all that is left is implementation.

@github-actions github-actions bot added A-docs Related to documentation. A-ci Related to CI. labels Jun 20, 2024
A tracking issue is however not meant for large scale discussion, questions, or bug reports about a feature.
Instead, open a dedicated issue for the specific matter.

### What
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are ### instead of ## like other issue templates because:

  1. rust-lang/rust does it like this
  2. It makes this template stand-out

@hinto-janai
Copy link
Contributor Author

Btw I plan on retroactively making one of these for cuprate-database and adding it as an example to CONTRIBUTING.md.

@hinto-janai
Copy link
Contributor Author

Active example: #183

@Boog900 Boog900 merged commit f6c4e4e into Cuprate:main Jun 20, 2024
6 checks passed
@hinto-janai hinto-janai deleted the tracking-issue-label branch June 20, 2024 23:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-ci Related to CI. A-docs Related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants