From 009e0fc485e0d6c7cbe9fa8b4dfb8c902fc97a1d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mihai=20Capot=C4=83?= Date: Thu, 14 Nov 2019 14:44:15 -0800 Subject: [PATCH] docs: Add Co-authored-by With our current workflow, we are not crediting all authors. See for example PR #364, where Vy Vo is not credited. --- CONTRIBUTING.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 65b76b395..18d669c6c 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -72,8 +72,10 @@ step-by-step description of our recommended workflow: git push --set-upstream origin new-feature # only for the first push git push # for all subsequent pushes -9. When your feature is ready, make a pull request on GitHub. After your - feature is accepted, update your ``master`` branch and delete your feature +9. When your feature is ready, make a PR on GitHub. If you collaborate with + others on the code, credit them using Co-authored-by_; if you are merging a + PR, credit all authors using Co-authored-by_ in the PR squash message. After + your PR is merged, update your ``master`` branch and delete your feature branch:: git checkout master @@ -88,6 +90,8 @@ requests`_ for more information. https://pip.pypa.io/en/latest/development/#adding-a-news-entry .. _GitHub help for collaborating on projects using issues and pull requests: https://help.github.com/categories/collaborating-on-projects-using-issues-and-pull-requests/ +.. _Co-authored-by: + https://help.github.com/en/github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors All pull requests are automatically tested using the ``pr-check.sh`` script. You should test you contributions yourself on your computer using