Skip to content
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.

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

Recommendations for git/GitHub #7

Open
2 tasks
milanmlft opened this issue Oct 20, 2023 · 2 comments
Open
2 tasks

Recommendations for git/GitHub #7

milanmlft opened this issue Oct 20, 2023 · 2 comments
Assignees

Comments

@milanmlft
Copy link
Member

milanmlft commented Oct 20, 2023

Should we also add some recommendations regarding git/GitHub use?
E.g.

  1. Commit messages (length, contents, ...)
  2. Branch names
  3. PR titles
  4. PR merge strategy (<-- I feel this one is most impactful)
  5. Branch protection rules
  6. Other GH settings like automatic branch deletion, required reviewers, ...
  • ...

Also related: use of semantic versioning

Definition of done

  • There is an initial GitHub page.
  • Review of internal docs for stuff to pull out.
@samcunliffe
Copy link
Member

samcunliffe commented Oct 20, 2023

It's interesting that I think of most of these things as obvious. But yeah, maybe we should write this all down.

2: Branch names we de-facto always seem to use <initials>/<name of feature>

sc/fix-milans-terrible-production-critical-bug-issue-01

... just as a random example. Do we need to write down that we recommend <initials>/description-of-feature?

@milanmlft
Copy link
Member Author

I think that's not a terrible idea. I for one wasn't really used to that style but just started doing it as I saw that others were doing it in my projects.
Another convention is to use <category>/<description>, where <category> is one of a limited set of doc, fix, feat, test for example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants