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.

Modifying existing file

If you modify an existing file, please keep the existing license header as it is and just add your copyright notice and author:

@author <your name> <your email address>

Creating new file

/**
 * @copyright Copyright (c) <year>, <your name> (<your email address>)
 *
 * @author <your name> <your email address>
 * 
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

Sign your existing work

Usually email will be already configured with your Github.

git config --global user.name "FirstName LastName"
git config --global user.email "email@provider.com"

Refer here for additional details.

git add .
git commit -s -m "commit message"

Please note : Use your real name (sorry, no pseudonyms or anonymous contributions).

Once pushed - you should see the commit have the following template in github

Signed-off-by: FirstName Initials/Lastname <email@provider.com>

Sign your previous work

In case you forget to sign your work, you can do the following:

# sign the last N commits - replace N before executing the command
git rebase HEAD~N --signoff
git push -f

Project Structure

Please refer to NocoDB Repository Structure.

Financial Contribution

Isn't this product cool? We are working on this full time. Your donations will definitely help us to make this even better.

• Funding NocoDB's work on Github

Credits

Once again. Thank you to all the people who have already contributed to NocoDB!