[BLIP-9] Repo Branch Standards

[humbitious]

Branch Naming Standards

There should be prominently featured in the docs and top readme what our community's standards are for Branch naming and management (included hygiene).

---

Copyright Copyright and related rights waived via CC0-Universal.

(This template adapted from the EIP template at https://github.com/ethereum/EIPs/

[GoldenBit0]

Notes from 11/15/21 Core Devs session:

• Core Devs should comment under issue with proposals for branch naming standards.

[skarred14]

Agreed, this can be addressed ideally by using a plugin like husky to add custom branch naming rules.

[ognjenkurtic]

Branch naming and git flow proposal:

master - main development branch, feature and release branches branched from it, changes only through the PR process.

feature/this-is-a-new-feature-branch - in case no related BLIP exists feature/BLIP-9-repo-branch-standards - in case related BLIP exists

release/1.0.0 - cut from master when ready

We can introduce more complex git flow once we have more development activity.

Rebase instead of merge:

After completed work on a feature branch, rebase master before opening a PR. After PR approved rebase again to make sure changes from latest master picked up before merging the PR into master.

Commit messages proposal:

In the commit message, always continue the sentence "This commit does ...". Examples of good commit messages:

"Rename examples folder in the root of the repo to reference-implementations" "Add RabbitMQ client as another messaging interface implementation" "Bump dependency packages versions to fix potential security issues"

Let me know your thoughts.

[GoldenBit0]

Notes from 11/29/21:

• Unanimous approval for @ognjenkurtic's proposal above
• @humbitious & @GoldenBit0 will update docs and readme

[humbitious]

Propose that this change can wait until after we consider and move on new BLIP #12, switching from "master" to "main", because, whether we choose to make the master/main change or not, if we make BLIP-9's changes to readme/docs before then, we may have to change again. #conservationOfMotion @Therecanbeonlyone1969 ? @GoldenBit0 ?

[GoldenBit0]

12/13/21 Core Devs:

• Change once we have relative URIs in place

[GoldenBit0]

1/10/22 Core Devs:

Kyle Suggestions:

• Features have branch name feat/name
• Bugs have bugfix/name
• Blips/#

Next steps:

• @ognjenkurtic Document full list of naming conventions using proposal above and new comments
• @humbitious will write docs

[ognjenkurtic]

In addition to my proposal above, full list of naming conventions with included comments:

master(main after BLIP-12) - main development branch, feature and release branches branched from it, changes only through the PR process.

feature/this-is-a-new-feature-branch - in case no related BLIP exists feature/BLIP-9-repo-branch-standards - in case related BLIP exists

bugfix/name-of-the-bug

release/1.0.0 - cut from main when ready

[GoldenBit0]

1/24/22 Core Devs:

• Ognjen will update docs

[ognjenkurtic]

Opened a PR while waiting for @sonalllpatelll for update regarding proper way to update the docs.

[Kasshern]

@ognjenkurtic Once the docs have been reconciled following a synchronization issue due to the gitbook's branch pointer and the main branch, all doc changes will go through PRs to main. Expecting that reconciliation to be done this week.

[GoldenBit0]

5/2/22 Core Devs Call:

• Docs change will be pushed before next core devs call.

[GoldenBit0]

6/13/22 Core Devs Call:

• Pending PR for doc change, will be complete this week.

[GoldenBit0]

6/27/22 Core Devs Call:

• Docs updated, work can proceed

[GoldenBit0]

7/11/22 Core Devs Call:

• In progress

[GoldenBit0]

7/25/22 Core Devs Call:

• @ognjenkurtic please provide an update when ready or let us know if someone can help.

[ognjenkurtic]

Wrapping this up on Thursday, no help needed.

[ognjenkurtic]

https://github.com/eea-oasis/baseline/pull/490

[ognjenkurtic]

PR is merged. Is there anything else needed or we close this one?

[GoldenBit0]

We should be good. Thanks @ognjenkurtic!