Skip to content
Gallery
Treefmt
Readme: treefmt — one CLI to format your repo
About the project
Quickstart
Usage
Formatters
Contribution guidelines
Enabling nix flakes
More
Share
Explore

Contribution guidelines

The treefmt source code and this user guide are licensed under the
MIT license
⁠
. This file contains instructions that will help you make a contribution.

⁠
Before Contributing
⁠
⁠

Before sending a pull request, make sure that you read all the guidelines. If you have any doubt on the contribution guides, please
state it clearly in an issue
⁠
or ask the community on the
treefmt matrix server
⁠
.
Use your best judgement, and feel free to propose changes to this document in a pull request.

⁠
Guidelines for Developers
⁠
⁠

Make sure you have a
GitHub account
⁠
. Take a look at the
existing issues
⁠
and feel free to contribute.

⁠
First contribution
⁠
⁠

Please take a few minutes to read GitHub's guide on
How to Contribute to Open Source
⁠
. 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.

⁠
Getting started
⁠
⁠

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.

⁠
Making changes
⁠
⁠

Fork the repository on GitHub.
Create a branch on your fork.
You can usually base it on the master branch.
Make sure not to commit directly to master.
Make commits of logical and atomic units.
Make sure you have added the necessary tests for your changes.
Push your changes to a topic branch in your fork of the repository.
Submit a pull request to the original repository.

⁠
Examples of git history
⁠
⁠

Git history that we want to have Git history that we are trying to avoid

⁠
Checkers/linters/formatters
⁠
⁠

Run treefmt in the source directory before you commit your changes.
⁠
Additionally, it's always good to work on improving/adding examples and documentation.
Thank you for your interest!
Want to print your doc?
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.