[ADR]: Branch conventions and release workflow

sumiat commented 1 year ago

Description

This ADR will record the devision for branch naming conventions and release workflow. This may be combined with #112 , but it has been useful internally to treat them as separate tasks.

Approvers

@acouch @widal001 @daphnegold @lucasmbrown-usds (optional)

Options

No response

Decision Criteria

No response

Definition of Done

[ ] The approvers for this decision have been identified (ideally before work on the ADR starts)
[ ] The ADR is created and stored in documentation/decisions/adr with status "Accepted"
[ ] The ADR has been reviewed and approved by the approvers listed above
[ ] The ADR satisfies requirements that are outlined in the ADR template
[ ] Any follow-up tickets have been created (if necessary)

lucasmbrown-usds commented 1 year ago

Looks good! No need to include me for approval, but I might watch it go by.

acouch commented 1 year ago

We have discussed some of this internally.

We have decided to adopt:

Git commit conventions decided here: https://github.com/HHS/grants-equity/issues/112
Prefix the branch name with your name, and include the ticket number in the branch name e.g. acouch/issue-1234-new-feature
Squash merge PRs
PR Title: “[Issue N] Short description”
Ask for reviewer on team for PRs
Merge own PR
Start off with a trunk based development https://trunkbaseddevelopment.com/
Use https://calver.org/ to version releases

Will draft an ADR ASAP.

acouch commented 1 year ago

We should also update the https://github.com/HHS/grants-equity/blob/main/CONTRIBUTING.md file in this ticket.

HHS / simpler-grants-gov