ZenithInfo/CONTRIBUTING.md

Contributing to ZenithInfo

Thanks for taking the time to contribute to ZenithInfo! Please read through this document to ensure that your contribution is in compliance with our guidelines. We are excited to have you contribute to our project!

Conventional Commits

We follow a subset of the Conventional Commits specification, defined below, for our commit messages. Please ensure that your commit messages are in the correct format.

Acceptable types

• feat: A new feature (minor)
• fix: A bug fix (patch)
• refactor: A code change that rewrites/restructures code, without changing behavior
• perf: A code change that improves performance without changing behavior (variation of refactor)
• style: A code change that does not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• test: Adding missing tests or correcting existing tests
• docs: Documentation only changes
• build: Changes that affect the build system, ci pipeline, project version, or external dependencies
• chore: Other changes that don't modify src or test files, such as updating .gitignore

Acceptable scopes

This section is a Work in Progress, and will change as the project matures.
Scopes are optional! If your commit does not fit into any of the scopes listed below, you can omit the scope.
Please do not use issue identifiers as scopes.

• ZenithInfo: any changes to the main projetc
• nix: changes to the nix flake or .envrc file
• repo: changes to the repository, such as the README, CONTRIBUTING, or LICENSE files
• tooling: changes to development tooling like dotnet tools