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

MAINTAINERS.md: add release notes template #392

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

neo-cypher
Copy link
Contributor

PR Checklist

  • The PR title is formatted as follows: pkg/server: add TestXYZ for XYZ
    • The package name goes before the colon
    • The part after the colon uses the verb tense + phrase that completes the blank in, "This change modifies Gateway-MT to ___________"
    • Lowercase verb after the colon
    • No trailing period
    • Keep the title as short as possible. Ideally under 72 characters or shorter
    • No Markdown

Commit Message Body

  • What, why, please describe the tests and the performance impact (if any)
  • No Markdown
  • The body is wrapped at 72 characters unless it's really needed (ASCII art, table, or long link)
  • If there is a corresponding issue, add either Closes #1234, Fixes #1234, Resolves #1234 or Updates #1234 (the latter if this is not a complete fix) to this comment
  • If referring to a repo other than storj/edge, you can use the owner/repo#issue_number syntax: Fixes storj/common#1234
  • We do not use Signed-off-by lines. Please don't add them. Our Gerrit server & GitHub bots enforce CLA compliance instead
  • More: https://github.com/storj/docs/blob/main/code/Git.md
  • Delete these instructions once you have read and applied them

Related Issue

Code Review Checklist (to be filled out by reviewer)

  • Are there any authservice's database migrations? Are they forwards and backwards compatible?
  • Does the PR describe what changes are being made?
  • Does the PR describe why the changes are being made?
  • Does the code follow our style guide?
  • Does the code follow our testing guide?
  • Is the PR appropriately sized? (If it could be broken into smaller PRs, it should be)
  • Does the new code have enough tests? (every PR should have tests or justification otherwise. Bug-fix PRs especially)
  • Does the new code have enough documentation that answers "how do I use it?" and "what does it do?"? (both source documentation and higher level, diagrams?)
  • Does any documentation needs updating?
  • Do the database access patterns make sense?
  • Copy the Commit Message Body section contents into the submit prompt upon PR completion

Change-Id: I870464af8cc927f2084518d96cd3e40803495726
MAINTAINERS.md Outdated

## Github Release Template
Be sure to update these items from the template:
- v1.69.0 should be the current release tag.
Copy link
Contributor

Choose a reason for hiding this comment

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

are these versions here examples? I'm not sure I fully understand what it's trying to say

Copy link
Contributor

Choose a reason for hiding this comment

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

same

MAINTAINERS.md Outdated

## Github Release Template
Be sure to update these items from the template:
- v1.69.0 should be the current release tag.
Copy link
Member

Choose a reason for hiding this comment

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

should we just use some generic revisions instead? this feels confusing

Change-Id: Ic5742b3fd3625d659fccb8a3ca018dce296ac2fd
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants