diff --git a/docs/contributing.md b/docs/contributing.md index c5be3d7..9254696 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -8,26 +8,27 @@ This file contains instructions that will help you make a contribution. ## Licensing -The treefmt binaries and this user guide are licensed under the [MIT license](https://numtide.github.io/treefmt/LICENSE.html). +The `treefmt` binaries and this user guide are licensed under the [MIT license](https://numtide.github.io/treefmt/LICENSE.html). ## Before you contribute -Here you can take a look at the [existing issues](https://github.com/numtide/treefmt/issues). Feel free to contribute, but make sure you have a [GitHub account](https://github.com/join) first :) . +Here you can take a look at the [existing issues](https://github.com/numtide/treefmt/issues). Feel free to contribute, but make sure you have a +[GitHub account](https://github.com/join) first :slightly_smiling_face:. -If you're new to open source, please read GitHub's guide on [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/). It's a quick read, and it's a great way to introduce yourself to how things work behind the scenes in open-source projects. +If you're new to open source, please read GitHub's guide on [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/). It's a quick read, +and it's a great way to introduce yourself to how things work behind the scenes in open-source projects. -Before sending a pull request, make sure that you've read all the guidelines. If you don't understand something, please [state your question clearly in an issue](https://github.com/numtide/treefmt/issues/new) or ask the community on the [treefmt matrix server](https://matrix.to/#/#treefmt:numtide.com). +Before sending a pull request, make sure that you've read all the guidelines. If you don't understand something, please +[state your question clearly in an issue](https://github.com/numtide/treefmt/issues/new) or ask the community on the [treefmt matrix server](https://matrix.to/#/#treefmt:numtide.com). ## Creating an issue If you need to create an issue, make sure to clearly describe it, including: -- The steps to reproduce it if it's a bug -- The version of treefmt used -- The database driver and version -- The database version +- The steps to reproduce it (if it's a bug) +- The version of `treefmt` used -The cache database is stored in a toml file the ~/.cache/treefmt directory. +The cache database is stored in a `.db` file in the `~/.cache/treefmt/eval-cache` directory. ## Making changes @@ -36,7 +37,7 @@ If you want to introduce changes to the project, please follow these steps: - Fork the repository on GitHub - Create a branch on your fork. Don't commit directly to main - Add the necessary tests for your changes -- Run treefmt in the source directory before you commit your changes +- Run `treefmt` in the source directory before you commit your changes - Push your changes to the branch in your repository fork - Submit a pull request to the original repository @@ -44,10 +45,6 @@ Make sure you based your commits on logical and atomic units! ## Examples of git history -Git history that we want to have: - -Git history that we are trying to avoid: -
Git history that we want to have @@ -88,7 +85,7 @@ Git history that we are trying to avoid:
-Git history that we are trying to avoid: +Git history that we are trying to avoid ```