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

docs: update github templates #1453

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sbliven
Copy link
Contributor

@sbliven sbliven commented Oct 23, 2024

Description

Updates the PR and issue templates

Motivation

PRs were failing the pr-title-checker action because the title format wasn't well documented. Rather than add this to our documentation, I think it is easier to just mention it in the PR template.

While I was doing that I also changed both templates to include instructions as comments. I think this is common in other github projects.

Changes:

  • New github templates

Tests included

  • Included for each change/fix? (N/A)
  • Passing?

Documentation

  • swagger documentation updated (required for API changes) (N/A)
  • official documentation updated

official documentation info

I think the PR template is a better place for documentation than the other repo.

@sbliven sbliven changed the title Update github templates docs: update github templates Oct 23, 2024
@sbliven
Copy link
Contributor Author

sbliven commented Oct 23, 2024

One question: do we use the 'scope' part of titles for anything? Should we provide some guidelines about valid scicat scopes, or else remove this part of the regex entirely?

@sbliven
Copy link
Contributor Author

sbliven commented Oct 23, 2024

BTW, this pr triggered by the test failure and subsequent discussion in #1442

@sbliven sbliven requested a review from nitrosx October 23, 2024 09:13
@Junjiequan
Copy link
Contributor

Junjiequan commented Oct 23, 2024

The scope part is very optional and it's just used to add extra information e.g, fix(authentication): some text, test(dataset): some API testetc. And I'm fine with either keepingor removing the scope regex.
I just hope people use Squash Merge more often so that the final commit message includes fix: feat: format from PR title automatically, as release changelogs are based on the commit message.

Copy link
Contributor

@Junjiequan Junjiequan left a comment

Choose a reason for hiding this comment

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

Looks good to me

The main change is documenting the title-checker requirements in the PR
template
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants