Skip to content

Integrations and repositories best practices

Martin Makarský edited this page Mar 24, 2022 · 5 revisions

[Work in progress]

Naming conventions

All repositories should follow naming conventions.

CI/CD

Each official integration/repository that we provide should have a green test badge. It's recommended to use GitHub Action.

Commit messages

Use meaningful commit messages. Update readme.md commit message is insufficient. Consider using Semantic Commit Messages.

Language preferences

For JavaScript ecosystem projects and repositories, we prefer code written in TypeScript whenever it's possible. Nevertheless, it's perfectly fine to use JavaScript for PoCs, prototypes, and pre-beta projects.

Non-production ready projects

Sometimes it's convenient to make a repository public even though it's not ready for production. Public non-production-ready projects and repositories must be labeled with a disclaimer about work in progress.