🔥 🔥 🔥 A Free & Self-hostable Airtable Alternative nocodb.com
nocodb .github CONTRIBUTING.md
2.0 kB · 39 lines
Markdown

NocoDB Contributing Guide #

Thanks for spending your time to contribute! The following is a set of guidelines for contributing to NocoDB.

Table of Contents #

Pull Request Guidelines #

  • When you create a PR, you should fill in all the info defined in this template.

  • We adopt Gitflow Design. However, we do not have release branches.

  • The master branch is just a snapshot of the latest stable release. All development should be done in dedicated branches (e.g. feat/foo, fix/bar, enhancement/baz). All approved PRs will go to develop branch. Do not submit PRs against the master branch.

  • Checkout a topic branch from the relevant branch, e.g. develop, and merge back against that branch.

  • Multiple small commits are allowed on the PR - They will be squashed into one commit before merging.

  • If your changes are related to a special issue, add ref: #xxx to link the issue where xxx is the issue id. If your changes are meant to solve the issue, then add closes: #xxx instead.

  • If your changes doesn't relate to any issues, we suggest you to create a new issue first and ask for assignment. Also, it'd be better to discuss the design or solutions with the team members via Discord first.

Development Setup #

Please refer to Development Setup.

Committing Changes #

We encourage all contributors to commit messages following Commit Message Convention.

Applying License #

We require a CLA (Contributor License Agreement). This is a one-time process. Please click this link to agree to the CLA for nocodb/nocodb.