Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • GitHub Actions recommended

  • Pull request checks

    • DCO

    • Unit tests

    • Integration tests

    • Scans - see Security section, more comprehensive scans can be run nightly instead
  • Test coverage reporting

  • See Automated Pipelines task force - https://github.com/hyperledger/toc/issues/44

GitHub suggestions

  • Use .github/settings.yml so that repository settings can be managed and tracked via pull requests

  • Recommended initial repository settings, e.g. Repository options, Branch protection rules

  • Rebase merging is preferred over Merge commits and Squash merging to keep commit history clean (assuming contributors squash/amend their own pull requests)

  • 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.