Notes on Best Practices

Jump to bottom

Ion Y edited this page Jan 22, 2022 · 1 revision

What we might want to figure out best / worst practices for.

We do not need to do all of this, and whatever we do doesn't need to be done all at once. This is meant to be a list we can review and cherry pick from.

Languages

Notes on programming languages choices and tradeoffs
Best practices by programming language
Coding conventions
Agreement (at least on pros and cons of) toolchains for each phase of development.

Development

Testing (at multiple levels)
Documentation
Deployment
Project management
Bug tracking

API Design

Common constraints of APIs for services
Portability across languages

Tools & Services

GitHub:
- Conventions for wikis
- Best practice for discussions
- Life cycle of issues
- Templates for issues and PRs
- Life cycle of proposals
- Templates for types of documentation
- A useful set of labels

Security

TODO: This needs dedicated discussion