Skip to content

DOC add PR prefixes to maintainer docs #282

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.

Sign up for GitHub

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

Merged
BenjaminBossan merged 1 commit into from
Jan 24, 2023
+20 −0
Merged

DOC add PR prefixes to maintainer docs #282

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,26 @@ Please follow this workflow when contributing to skops:
- Push your branch to the remote repository
- Create a pull request on GitHub

Issue Titles / Commit Messages
------------------------------

When creating a pull request, please use a descriptive title. You can prefix
the title to indicate the type of it:

- ``DOC``: documentation changes
- ``FEAT/FEA``: new major features
- ``ENH``: enhancements to existing features with user facing implications
- ``CI``: continuous integration, sometimes overlaps with MNT
- ``MNT/MAINT``: maintenance, technical debt, etc
- ``FIX``: bug fixes
- ``TST``: new tests, refactoring tests
- ``PERF``: performance improvements

If a contributor forgets to prefix the title, a maintainer can add the prefix
when merging into ``main``. While merging, it is recommended that the
maintainer refines the commit message to add a short description of what the PR
being merged does.

Review Process
--------------

Expand Down