1.8 KiB
NocoDB Contributing Guide
Thanks for spending your time to contribute! The following is a set of guidelines for contributing to NocoDB.
- Code of Conduct
- Pull Request Guidelines
- Development Setup
- Project Structure
- Financial Contribution
- Credits
Pull Request Guidelines
-
When you create a PR, you should fill in all the info defined in this template.
-
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 themaster
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.
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.
Credits
Once again. Thank you to all the people who have already contributed to NocoDB!