docs: add CONTRIBUTING.md#353
Conversation
davidlougheed
left a comment
davidlougheed
left a comment
There was a problem hiding this comment.
looks good, although we will need to add in notes about AI to fully address what was discussed in meetings (maybe next version?)
final approval should come from @dbujold for this PR.
| - `chore/<short-description>` — tooling, dependency bumps | ||
| - `docs/<short-description>` — documentation-only changes | ||
|
|
||
| Including the Redmine ticket ID is encouraged, e.g. `feature/1234-add-search-endpoint`. |
There was a problem hiding this comment.
Not sure why this is "encouraged" when we don't seem to do it ourselves. At most I would expect the ticket number in the text of the pr, but even that seems rare.
There was a problem hiding this comment.
I mean before adding it as a requirement here, I would just confirm with the team on this.
| - Use a clear, conventional-commit-style title (e.g., `feat(<scope>): add X` or `fix: handle Y`). | ||
| - In the description, include: | ||
| - A short summary of the change and why it's needed. | ||
| - A link to the relevant Redmine ticket. |
There was a problem hiding this comment.
For Redmine, I thought we agreed that ticket numbers are sufficient.
There was a problem hiding this comment.
would just confirm with the team today and then add
chore: merged releases/v24
3 participants
Summary
CONTRIBUTING.mdcovering branch naming, commit conventions, PR process, bug/security reporting, and licensing.