Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (36 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

56 lines (36 loc) · 1.5 KB

Contribution Guidelines

🎉 First off, thank you for considering contributing to our project! 🎉

This is a community-driven project, so it's people like you that make it useful and successful. These are some of the many ways to contribute:

  • :bug/feat: Submitting bug reports and feature requests

Ground Rules

The goal is to maintain a diverse community that's pleasant for everyone. Please be considerate and respectful of others. Everyone must abide by our [Code of Conduct][docs/code-of-conduct.md] and we encourage all to read it carefully.

Commit Convention

We use the conventional commits specification for commit messages and pull/merge-request titles.

Scopes

Other scopes then the one in the specification are:

  • generic: If the commit targets only the generic template.
  • python: If the commit targets only the python template.
  • rust: If the commit targets only the rust template.
  • go: If the commit targets only the go template.

Testing

For all task, enter a development shell with just develop.

You can run tests with

just maintenance::test

Note: You can REPOSITORY_TEMPLATE_UPDATE_FLAKE=true just ... to update the Nix flake before the tests to update dependencies.

To test single templates use just maintenance::test [generic|go|python|rust].

Push the Templates

Push all repos to a test branch with

just maintenance upload-all

where you can also inspect the Github Action CI.