Skip to content

STY: Accept three-letter prefix for maintenance commits #56

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
merged 1 commit into from
May 27, 2025
Merged

STY: Accept three-letter prefix for maintenance commits #56

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
5 changes: 4 additions & 1 deletion docs/community/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,9 @@ but those accepted fastest will follow a workflow similar to the following:
using a [NiPreps development environment][link_devel].
Once you are satisfied with your local changes, [add/commit/push them][link_add_commit_push]
to the branch on your forked repository.
Note that that each commit must include changes that serve a coherent
purpose only (e.g. documentation, feature, bug fix) and that have a clear
scoped. They should be prefixed as indicated below.

1. **Submit a [pull request][link_pullrequest].**<br />
A member of the development team will review your changes to confirm
Expand All @@ -233,7 +236,7 @@ but those accepted fastest will follow a workflow similar to the following:
* `STY`: style changes ([example][sty_ex])
* `REF`: refactoring existing code ([example][ref_ex])
* `CI`: updates to continuous integration infrastructure ([example][ci_ex])
* `MAINT`: general maintenance ([example][maint_ex])
* `MAINT`/`MNT`: general maintenance ([example][maint_ex])
* For works-in-progress, add the `WIP` tag in addition to the descriptive prefix.
Pull-requests tagged with `WIP:` will not be merged until the tag is removed.

Expand Down