this repo has no description
docs(README): add contributing guide
+25
+25
README.md
+25
README.md
···
56
56
57
57
- gzip
58
58
- tar
59
+
60
+
# Contributing
61
+
62
+
## Development Environment
63
+
64
+
The primary supported developer environment is defined in the `flake.nix` file.
65
+
This is a [Nix Flake](https://nixos.wiki/wiki/Flakes) that pins versions of all packages used by `cmprss`.
66
+
It includes a `devShell` that can be used with [direnv](https://direnv.net/) to use the tools each time you enter the directory.
67
+
68
+
That being said, `cmprss` is a very standard Rust application and should work with recent Rust toolchains.
69
+
70
+
The CI runs on both a stable Rust toolchain and the pinned Nix versions to verify correctness of both.
71
+
72
+
If you run into any issues developing with either the Nix environment or a stable Rust environment, please open a Github issue with the details.
73
+
74
+
## Conventional Commits
75
+
76
+
Commits should conform to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard.
77
+
78
+
## @patricksjackson
79
+
80
+
I am the only developer on this right now, and I usually develop by committing directly to the `main` branch.
81
+
For larger features I _may_ go through a PR to run CI and to have some more easily discoverable documentation of a specific feature.
82
+
83
+
I will stop commiting directly to `main` as soon as someone else submits a non-trivial PR and then submits a request to remove this section of the README.