From 34135cf24b4a4fd560bba8ee1d450f1ef9c6c30c Mon Sep 17 00:00:00 2001 From: cswimr Date: Tue, 31 Dec 2024 00:11:51 -0500 Subject: [PATCH] chore(repo): add a CONTRIBUTING.md file --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3372281 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# 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](https://www.conventionalcommits.org/en/v1.0.0/) 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