From ef9207f1d978972eed5ff75e2d697e71f87098c5 Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Sun, 23 Jan 2022 16:51:53 +0800 Subject: [PATCH] docs: init CONTRIBUTING.md Signed-off-by: Wing-Kam Wong --- .github/CONTRIBUTING.md | 45 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000000..7850b80bd3 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,45 @@ +# NocoDB Contributing Guide + +Thanks for spending your time to contribute! The following is a set of guidelines for contributing to NocoDB. + +- [Code of Conduct](https://github.com/nocodb/nocodb/blob/master/.github/CODE_OF_CONDUCT.md) +- [Pull Request Guidelines](#pull-request-guidelines) +- [Development Setup](#development-setup) +- [Project Structure](#project-structure) +- [Financial Contribution](#financial-contribution) +- [Credits](#credits) + +## Pull Request Guidelines + +- When you create a PR, you should fill in all the info defined in this [template](https://github.com/nocodb/nocodb/blob/master/.github/pull_request_template.md). + +- 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](https://github.com/nocodb/nocodb#development-setup). + +### Committing Changes + +We encourage all contributors to commit messages following [commit message convention](./COMMIT_CONVENTION.md). + +## Project Structure + +Please refer to [NocoDB Repository Structure](https://docs.nocodb.com/#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](https://github.com/sponsors/nocodb) + +## Credits + +Once again. Thank you to all the people who have already contributed to NocoDB! \ No newline at end of file