github.com/tuhaihe/gpbackup@v1.0.3/CONTRIBUTING.md (about) 1 Cloudberry Database community welcomes contributions from anyone, new and 2 experienced! We appreciate your interest in contributing. This guide will help 3 you get started with the contribution. 4 5 ## Code of Conduct 6 7 Everyone who participates in Cloudberry Database, either as a user or a 8 contributor, is obliged to follow our community [Code of 9 Conduct](./CODE_OF_CONDUCT.md). Every violation against it will be reviewed 10 and investigated and will result in a response that is deemed necessary and 11 appropriate to the circumstances. The moderator team is obligated to maintain 12 confidentiality regarding the reporter of an incident. 13 14 Some behaviors that contribute to creating a positive environment include: 15 16 * Use welcoming and inclusive language. 17 * Respect differing viewpoints and experiences. 18 * Accept constructive criticism gracefully. 19 * Foster what's best for the community. 20 * Show empathy for community members. 21 22 ## GitHub Contribution Workflow 23 24 1. Fork this repo to your own GitHub account. 25 2. Clone down the repo to your local system. 26 27 ``` 28 git clone https://github.com/your-user-name/gpbackup.git 29 ``` 30 31 3. Add the upstream repo. (You only have to do this once, not every time.) 32 33 ``` 34 git remote add upstream https://github.com/tuhaihe/gpbackup.git 35 ``` 36 37 4. Create a new branch to hold your work. 38 39 ``` 40 git checkout -b new-branch-name 41 ``` 42 43 5. Work on your new code. 44 45 * Add new tests to cover your code. We use 46 [Ginkgo](http://onsi.github.io/ginkgo/) and 47 [Gomega](https://onsi.github.io/gomega/) for testing. 48 * Run `make format`, `make test`, and `make end_to_end` in your feature branch 49 and ensure they are successful. 50 51 6. Commit your changes. 52 53 ``` 54 git add <the change files> 55 git commit 56 ``` 57 58 7. Push your changes to your GitHub repo. 59 60 ``` 61 git push origin new-branch-name 62 ``` 63 64 8. Open a PR(Pull Request). 65 66 Go to the repo on GitHub. There will be a message about your recently pushed 67 branch, asking if you would like to open a pull request. Follow the prompts, 68 compare across repositories, and submit the PR. 69 70 9. Get your code reviewed. 71 10. Congratulations! Once your PR is approved, and passes the CI/CD without 72 errors, then the code will be merged. Your code will be shipped in the recent 73 future releases. 74 75 ## Sync your branch with the upstream 76 77 Before working on your next contribution, make sure your local repository is 78 up to date: 79 80 ``` 81 git checkout main 82 git fetch upstream 83 git rebase upstream/main 84 ```