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

Accept more prefixes for PR titles #463

Closed
fepegar opened this issue Jun 27, 2022 · 4 comments
Closed

Accept more prefixes for PR titles #463

fepegar opened this issue Jun 27, 2022 · 4 comments
Labels
code quality Issues around style, re-usability, test coverage good first issue Good for newcomers

Comments

@fepegar
Copy link
Contributor

fepegar commented Jun 27, 2022

Currently, we have the following:

allowed_prefixes: 'ENH,BUG,STYLE,DOC,DEL' # title should start with the given prefix

We might want to be more precise or accurate sometimes. I've seen others that could be useful. For example:

  • TEST: to add or modify tests
  • FIX: to fix something that is not necessarily a BUG such as a typo
  • MNT: maintenance, to upgrade a package version (ENH: Upgrade PyTorch Lightning to 1.6.4  #453) or stuff related to packaging, linting, CI, etc.
  • STY: as a shorter alternative to STYLE
  • REL: for release commits
  • WIP: for work in progress (I don't like this, I think using drafts PRs is better)
  • COMP: fix e.g. warnings (I think it comes from "compiling" or similar)
  • PERF: improve performance

Some sources:

@fepegar fepegar added question Further information is requested code quality Issues around style, re-usability, test coverage labels Jun 27, 2022
@Shruthi42
Copy link
Contributor

Maybe we could have prefixes related to deprecating code as well. What is the recommended prefix for code deprecation PRs at the moment, DEL?

@fepegar
Copy link
Contributor Author

fepegar commented Jun 27, 2022

Maybe we could have prefixes related to deprecating code as well. What is the recommended prefix for code deprecation PRs at the moment, DEL?

I guess DEL would make sense for that, yes. These are all soft rules, anyway.

@ant0nsc
Copy link
Collaborator

ant0nsc commented Jun 28, 2022

REL, COMP don't really apply to us, I would drop those. And clearly no WIP. The others sound OK to me.

@fepegar fepegar added good first issue Good for newcomers and removed question Further information is requested labels Jun 28, 2022
@fepegar
Copy link
Contributor Author

fepegar commented Aug 1, 2022

Addressed in #505.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code quality Issues around style, re-usability, test coverage good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants