...
Documentation - see also Documentation task force and Onboarding task forcesforce
User guide including Getting Started / Tutorial
Project developer guide including coding guidelines, build instructions, test instructions
Application developer guide
- Recommended documentation platform?
...
Define repository settings in .github/settings.yml so that they can be managed and tracked via pull requests
Recommended initial Use recommended repository settings as a starting point, e.g. Repository options, Branch protection rules (TBD by TOC and Hyperledger staff)
Rebase merging is preferred over Merge commits and Squash merging to keep commit history clean (assuming contributors squash/amend their own pull requests) - opinion or best practice?
Although there are often multiple paths to achieve an outcome in git and GitHub, there is value in defining a suggested path, both for the benefit of new GitHub users, and for the sake of project consistency.
Examples - amending commits versus squashing commits, Mergifyio to simplify cherry picks and backports.
Example guidance - for forking, branching, remotes, creating pull requests, updating pull requests - https://hyperledger-fabric.readthedocs.io/en/latest/github/github.html