nocodb/.github/CONTRIBUTING.md

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
• Development Setup
  • Committing Changes
  • Applying License
    • Modifying existing file
    • Creating new file
    • Sign your existing work
    • Sign your previous work
• Project Structure
• Financial Contribution
• Credits

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. 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.

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.