HOWTO Repos

Repos are the primary engineering collaborative asset. Most if not all contributions are in a Repo

Make it public

By default, think about making your contributions in a public repo.

Or keep it private

For whatever reasons, some things may need to be kept private. In that case make a private repo.

  • Not on Github

  • On Radicle

Best Practice

  • A repo has a README.md

  • From the beautiful template

  • With concise instructions to both, set up locally, and deploy, and link to deployed instance

  • Has scripts to do annoying parts and sets prerequisites clearly

  • Can be tested, verified, locally, and once deployed

  • Is kept stable

  • Rushed code is likely not worth it

Contributing

  • Create a branch from base before making code changes

  • then create a PR with some context, the what, not so much the how unless the code can’t tell.

  • Get it reviewed before merging

  • Review PRs you are invited to or say that you won’t or can’t

  • Sign your commits

  • Provide meaningful commit messages

  • Configure your IDE properly and apply linters

Respect the code base and leave it cleaner than you found it.

Engage in refactoring surrounding code and keep changesets reasonable, nobody want to go through massive diffs.

Comments are OK, but it’s better when the code is self commenting.