Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
otb
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Main Repositories
otb
Commits
c85f9156
Commit
c85f9156
authored
7 years ago
by
Manuel Grizonnet
Browse files
Options
Downloads
Patches
Plain Diff
Update CONTRIBUTING.md (add list of valid prefix commit message)
parent
04773b6c
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!1
DOC: Add CONTRIBUTING and PSC docs
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.md
+11
-1
11 additions, 1 deletion
CONTRIBUTING.md
with
11 additions
and
1 deletion
CONTRIBUTING.md
+
11
−
1
View file @
c85f9156
# How to contribute to Orfeo ToolBox
# How to contribute to Orfeo ToolBox
?
Thank you for taking the time to contribute to OTB! This document will guide you
through the workflow and best practices you need to know to send your
...
...
@@ -72,6 +72,16 @@ commit message so that GitLab can [crosslink it](https://docs.gitlab.com/ce/user
You can prefix your commit message with an indicating flag (DOC, BUG, PKG,
TEST, SuperBuild, etc.) or the name of the module you are changing.
Standard prefixes for OTB commit messages:
BUG: Fix for runtime crash or incorrect result
COMP: Compiler error or warning fix
DOC: Documentation change
ENH: New functionality
PERF: Performance improvement
STYLE: No logic impact (indentation, comments)
WIP: Work In Progress not ready for merge
For example, here are some good commit messages:
BUG: #1701 Warn users if parameter string is unset
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment