diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 867d9cde47..5c15f7c943 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,6 +33,8 @@ Generally, we follow the "fork-and-pull" Git workflow. 4. [Commit](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork) changes to your own branch, then push to to GitHub with `git push --set-upstream origin my-topic-branch`. You must record your changes in [CHANGELOG.md](CHANGELOG.md) with issue numbers and descriptions. 5. Submit a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) so that we can review your changes. +![](docs/developer_guides/figs/fork-and-pull.png) + Remember to [sync your forked repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#keep-your-fork-synced) *before* submitting proposed changes upstream. If you have an existing local repository, please update it before you start, to minimize the chance of merge conflicts. ```shell @@ -42,6 +44,8 @@ git pull upstream master git checkout -b my-topic-branch ``` +![](docs/developer_guides/figs/local-develop-steps.png) + ### General guidelines Before submitting your pull requests for review, make sure that your changes are consistent with the [coding style](CONTRIBUTING.md#coding-style), and run [unit tests](CONTRIBUTING.md#run-unit-test-with-code-coverage) to check your code coverage rate. diff --git a/docs/developer_guides/figs/fork-and-pull.png b/docs/developer_guides/figs/fork-and-pull.png new file mode 100644 index 0000000000..325c2189fa Binary files /dev/null and b/docs/developer_guides/figs/fork-and-pull.png differ diff --git a/docs/developer_guides/figs/local-develop-steps.png b/docs/developer_guides/figs/local-develop-steps.png new file mode 100644 index 0000000000..1e504a338b Binary files /dev/null and b/docs/developer_guides/figs/local-develop-steps.png differ