Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged!
Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.
Table of Contents
We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold the Contributor Covenant Code of Conduct.
Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:
- To report security vulnerabilities, please contact us directly at help@dev.tools
- Search for existing Issues and PRs before creating your own
- We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking
Issues should be used to report a problem, request a new feature, or to discuss potential changes before a PR is created. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate.
If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a reaction can also help be indicating to our maintainers that a particular problem is affecting more than just the reporter.
PRs are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should:
- Only fix/add the functionality in question
- Address a single concern in the least number of changed lines as possible
- Include a Version Plan describing the changes and semantic versioning information. You can run
nx release planto generate it with an interactive guide - Be accompanied by a complete Pull Request template (loaded automatically when a PR is created)
For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.
In general, we follow the "fork-and-pull" Git workflow
- Fork the repository to your own GitHub account
- Clone the project to your machine
- Create a branch locally with a succinct but descriptive name
- Commit changes to the branch
- Ensure all formatting and testing checks pass by running
task lintandtask test - Push changes to your fork
- Open a PR in our repository and follow the PR template so that we can efficiently review the changes
The development environment for this project is set up using Nix Flakes for full reproducibility. You may chooose to set your environment manually, but we won't be able to help you if issues arise. For best results set up the following software:
- Nix with Flakes enabled. We recommend using Determinate Nix Installer for good defaults
- Direnv, see installation instructions. Run
direnv allowin project root to activate the environment - Visual Studio Code with recommended extensions
Make sure to update project dependencies by running pnpm install and go install tool before making any changes.
This is a list of tools that we frequently use throughout the project, along with accompanying references. It is helpful for quickly looking up certain information during development.
- Libsql - Unix like - Website - Github
- Sqlite - Windows - Website - Go Reference
- Connect for Go Docs
- Ulid - Go Reference
- GVal - Go Reference
- Compressed - Go Reference
- TanStack Router - Docs
- TanStack Query - Docs
- TanStack Table - Docs
- normy - Core - TanStack Query
- React Flow - Docs - API - Components - Examples