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](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
- `ci`: Changes to our CI configuration files and scripts
- `chore`: Other changes that don't modify src or test files, such as updating .gitignore or updating dependencies

### 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.

- `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
- `deps`: changes to dependencies, such as updating dependencies or removing unused dependencies
- `renovate`: changes to the Renovate configuration
chore(repo): add a CONTRIBUTING.md file 2024-12-31 00:11:51 -05:00			`# 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
chore(repo): add a separate cc type for ci changes 2024-12-31 00:27:22 -05:00			- `ci`: Changes to our CI configuration files and scripts
chore(repo): remove useless type 2024-12-31 00:34:34 -05:00			- `chore`: Other changes that don't modify src or test files, such as updating .gitignore or updating dependencies
chore(repo): add a CONTRIBUTING.md file 2024-12-31 00:11:51 -05:00
			`### 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.`

			- `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
chore(renovate): Configure Renovate (#1) Welcome to [Renovate](https://github.com/renovatebot/renovate)! This is an onboarding PR to help you understand and configure settings before regular Pull Requests begin. 🚦 To activate Renovate, merge this Pull Request. To disable Renovate, simply close this Pull Request unmerged. --- ### Detected Package Files * `.config/dotnet-tools.json` (nuget) ### Configuration Summary Based on the default config's presets, Renovate will: - Start dependency updates only once this onboarding PR is merged - Enable Renovate Dependency Dashboard creation. - Use semantic commit type `fix` for dependencies and `chore` for all others if semantic commits are in use. - Ignore `node_modules`, `bower_components`, `vendor` and various test/tests (except for nuget) directories. - Group known monorepo packages together. - Use curated list of recommended non-monorepo package groupings. - Apply crowd-sourced package replacement rules. - Apply crowd-sourced workarounds for known problems with packages. - Pin Docker digests. - Pin `github-action` digests. - Enable Renovate configuration migration PRs when needed. - Pin dependency versions for `devDependencies`. 🔡 Do you want to change how Renovate upgrades your dependencies? Add your custom config to `renovate.json` in this branch. Renovate will update the Pull Request description the next time it runs. --- ### What to Expect It looks like your repository dependencies are already up-to-date and no Pull Requests will be necessary right away. --- ❓ Got questions? Check out Renovate's [Docs](https://docs.renovatebot.com/), particularly the Getting Started section. If you need any further assistance then you can also [request help here](https://github.com/renovatebot/renovate/discussions). --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-config-hash:da08744ed78376d9b26e0d0e71adc5e9c16901860bce15a6fad8bd3ed9f2038e--> Co-authored-by: cswimr <seaswimmerthefsh@gmail.com> Reviewed-on: https://www.coastalcommits.com/Zenith/ZenithInfo/pulls/1 Reviewed-by: cswimr <seaswimmerthefsh@gmail.com> Co-authored-by: Renovate <renovate@coastalcommits.com> Co-committed-by: Renovate <renovate@coastalcommits.com> 2024-12-31 00:39:01 -05:00			- `deps`: changes to dependencies, such as updating dependencies or removing unused dependencies
			- `renovate`: changes to the Renovate configuration