Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
86 lines (60 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

86 lines (60 loc) · 2.48 KB

Contributing to tree-sitter-sql

Getting Started

Clone the repository and run the setup script.

git clone https://github.com/DerekStride/tree-sitter-sql.git
npm install

Testing

The Makefile will ensure the parser is generated & compiled when testing changes during development. Use make test to run the testsuite.

Before you commit it's a good idea to run make format to make sure the tests are will formatted & correct. Be careful to make sure there are no unintended updates to the tests.

Commit Messages

Follow the conventional commits guidelines to make reviews easier and to make the git logs more valuable. The general structure of a commit message is:

<type>([optional scope]): <description>

[optional body]

[optional footer(s)]
  • Prefix the commit subject with one of these types:
    • feat, build, fix, docs, refactor, test
  • Append optional scope to type such as (ast).
  • Breaking changes to the syntax tree must be indicated by
    1. "!" after the type/scope, and
    2. a "BREAKING CHANGE" footer describing the change. Example: 
      refactor(ast)!: remove predicate and merge into binary_expression

BREAKING CHANGE: The `(predicate)` node has been replaced with `(binary_expression)`

Github Pages

To run the Github pages server, execute the following commands and open localhost:4000.

$ cd docs/
$ bundle install
$ bundle exec jekyll serve

Pushing a new Version

We use commit-and-tag-version to automate bumping the version number and preparing for a release. Run the following to generate the release:

$ npm run release

Ensure you also bump the version in tree-sitter.json, Cargo.toml, pyproject.toml, & CMakeLists.txt before pushing the changes.

Verify that all the changes are correct and push the updates to a new branch.

git push

Tagging

Once that PR is merged, pull the latest main and create the new tag, finally, push the tag.

git pull origin main
git tag v0.3.11
git push --tags

This will trigger a workflow that will generate the parser files & upload them to a new draft release. When the release is published Github Actions will publish the new packages to npm, cargo, & pypi.