Skip to content

Commit d1688e3

Browse files
committed
A bit on contributing.
1 parent b3ce204 commit d1688e3

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

slides.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -731,3 +731,30 @@ Co-authored-by: Matthew Scroggs <mscroggs@users.no-reply.github.com>"
731731
- Bugfixes.
732732

733733
---
734+
735+
# Contributing guide
736+
737+
---
738+
739+
# CONTRIBUTING.md
740+
741+
- Conventionally SHOUTED at the root of a repository.
742+
- Explains how to contribute to the project.
743+
- A good idea to write one _yourselves_ when starting a new collaborative project together.
744+
- Doesn't need to be long. Just write down what is expected.
745+
746+
---
747+
748+
# Things to think about
749+
750+
- Do you want people to fork and PR, or work in branches in the main repo?
751+
- Branch naming convention?
752+
{`feature/xyz`, `bugfix/abc`, `hotfix/123`} or user prefix {`sc/fix-bug-1337`, `ms/add-feature-42`}.
753+
- Who merges PRs? (The reviewer? The PR author?)
754+
- Should you squash merge or not?
755+
- Code style guidelines? Linters?
756+
- How do you want bugs to be reported?
757+
- How do you want features to be requested?
758+
- Internal vs external collaborators.
759+
760+
---

0 commit comments

Comments
 (0)