From 34fa4be86053ed0ad95a7e16a78732b98396966e Mon Sep 17 00:00:00 2001 From: noatamir Date: Mon, 23 May 2022 18:20:43 +0200 Subject: [PATCH 1/3] adding saved replies to development guide, under triage --- doc/devel/saved_replies.rst | 95 +++++++++++++++++++++++++++++++++++++ doc/devel/triage.rst | 8 ++++ 2 files changed, 103 insertions(+) create mode 100644 doc/devel/saved_replies.rst diff --git a/doc/devel/saved_replies.rst b/doc/devel/saved_replies.rst new file mode 100644 index 000000000000..0c28f7497d6a --- /dev/null +++ b/doc/devel/saved_replies.rst @@ -0,0 +1,95 @@ + +.. _saved_replies: + +Saved replies +============= + +To facilitate DRY (do not repeat yourself) communication principles, reduce potential bias and errors in +communication, and consistently maintain respectful and welcoming communication we decided to develop and collect a set +of reusable replies for recurring project needs. + +Our goal is to write welcoming and friendly communication which encourage participation and contribution in various +ways and at different levels of technical experience, as well as clarifies what we are able, and sometimes are not able, +to support our community with. + +As a maintainer, triage team member, or any other active community member, it may be helpful to store some of these in +your GitHub account’s `saved replies`_ for reviewing issues and PRs, and supporting other community members, as they participate +and contribute to Matplotlib. + +Our saved replies can be long and detailed. This is because we aim to offer support without assuming the level of +experience, or the intent the community member we are addressing might have. There is still room for one to tweak and +personalize the message, if based on the ongoing conversation some parts are redundant, require further information, or +if they want to add a personal note to suggest that they will be available to offer support, for example. + +Our intent with providing a baseline is to make it easier to not miss the minimum amount of information, and +consistently facilitate the respectful and welcoming interactions we aspire to maintain, not to set rigid communication +constraints. We trust our maintainers, triage team members, and all community members who continue to abide by our +`Code of Conduct`_, to communicate freely. It is based on their ongoing experience that we are able to provide these saved +replies to begin with. + +.. _Code of Conduct: https://github.com/matplotlib/matplotlib/blob/master/CODE_OF_CONDUCT.md +.. _saved replies: https://github.com/settings/replies/ + +Issues +------ + +Coming soon 😉 + +Pull Requests +------------- + +First Pull Request Merged +^^^^^^^^^^^^^^^^^^^^^^^^^ +Hi-five ✋ on merging your first pull request to Matplotlib, @username! We hope you stick around and invite you to continue to take an active part in Matplotlib! + +Your choices aren’t limited to programming 😉 – you can review pull requests, help us stay on top of new and old issues, develop educational material, refresh our documentation, work on our website, create marketing materials, translate website content, write grant proposals, and help with other fundraising initiatives. For more info, check out: https://matplotlib.org/stable/devel/index + +Also, consider joining our `mailing list`_ ✉️. This is a great way to connect with other people in our community and be part of important conversations that affect the development of Matplotlib. + +If you haven’t yet, do join us on `gitter`_ and `discourse`_ 🗣. The former is a chat platform, which is great when you have any questions on process or how to fix something, the latter is a forum which is useful for longer questions and discussions. + +Last but not least, we have a monthly meeting 👥 for new contributors and a weekly meeting for the maintainers, everyone is welcome to join both! You can find out more about our regular project meetings in this `calendar page`_. + +.. _mailing list: https://mail.python.org/mailman/listinfo/matplotlib-devel +.. _discourse: https://discourse.matplotlib.org/ +.. _calendar page: https://scientific-python.org/calendars/ + +Rebase +^^^^^^ + +Hi, it looks like we’d need to rebase your code to make sure it includes changes that have since occurred in the main +repository. Would you like to do this yourself, or would you like us to do this for you? I’m asking because a rebase can +get a bit fiddly and not everyone likes doing them 😉 + +If you want to rebase, the first thing to do is to squash all your commits into one, which will make the job easier. +Make sure you are in the PR branch, then to rebase, for eleven commits do:: + +$ git rebase --interactive HEAD~11 + + +And follow the instructions, basically replace 'pick' by 'f' in all but the first commit. Then update your main branch +from upstream, change back to the PR branch and do:: + +$ git rebase main + + +and if there are problems, do ``$ git status`` to see which files need fixing, then edit the files to fix up any conflicts +(sections marked by "<<<") . When you are done with that:: + +$ git add +$ git rebase --continue +$ git push --force-with-lease origin HEAD + + +If you have any problems, feel free to ask questions. + + +PS. +If at any point anything goes wrong, and you don't know what to do, just do:: + +$ git rebase --abort + +and everything will go back to the way it was in the before ``$ git rebase`` times, and you can come back here or to +`gitter`_, and ask us for help, or that we do the rebase after all 😉. + +.. _gitter: https://gitter.im/matplotlib/matplotlib \ No newline at end of file diff --git a/doc/devel/triage.rst b/doc/devel/triage.rst index 5f274f482f13..3608fa1dc8af 100755 --- a/doc/devel/triage.rst +++ b/doc/devel/triage.rst @@ -21,6 +21,14 @@ If you do not have enough GitHub permissions do something (e.g. add a label, close an issue), please leave a comment tagging ``@matplotlib/triageteam`` with your recommendations! +Follow the saved replies guide for detailed instructions on how to +use and contribute to our communication repository. + +.. toctree:: + :maxdepth: 2 + + saved_replies.rst + Working on issues to improve them --------------------------------- From 3243012943936247c26d3d42b2a7fe63978d966b Mon Sep 17 00:00:00 2001 From: noatamir <6564007+noatamir@users.noreply.github.com> Date: Thu, 30 Jun 2022 18:27:37 +0200 Subject: [PATCH 2/3] adding saved replies and git workflows to developer guide, under triage. --- doc/devel/git_workflows.rst | 44 ++++++++++++++++++++++++++++++ doc/devel/saved_replies.rst | 53 +++++++++++++++++++++++++++++++++++++ doc/devel/triage.rst | 10 +++++++ 3 files changed, 107 insertions(+) create mode 100644 doc/devel/git_workflows.rst create mode 100644 doc/devel/saved_replies.rst diff --git a/doc/devel/git_workflows.rst b/doc/devel/git_workflows.rst new file mode 100644 index 000000000000..e7a6e6179a4e --- /dev/null +++ b/doc/devel/git_workflows.rst @@ -0,0 +1,44 @@ + +.. _git_workflows: + +Git workflows +============= + +When reviewing contributions, we sometime refer to this page to offer more detailed git workflows. + +.. _git_rebase: + +Rebase +^^^^^^ + +If you want to rebase, the first thing to do is to squash all your commits into one, which will make the job easier. +Make sure you are in the PR branch, then to rebase do:: + +$ git rebase --interactive upstream/main + + +Git opens the last commits you made in our terminal editor (often it's vim) and you need to follow the instructions in +the file. Basically replace 'pick' by 'fixup' (or simply 'f') in all but the first commit (exit vim using `:wq` to +write/save and quite). Then update your main branch from upstream, change back to the PR branch and do:: + +$ git rebase main + + +and if there are problems, do ``$ git status`` to see which files need fixing, then edit the files to fix up any +conflicts (sections marked by "<<<") . When you are done with that:: + +$ git add +$ git rebase --continue +$ git push --force-with-lease origin HEAD + +If you have any problems, feel free to ask questions. + +PS. +If at any point anything goes wrong, and you don't know what to do, just do:: + +$ git rebase --abort + +and everything will go back to the way it was in the before ``$ git rebase`` times, and you can come back to your PR, +or to `gitter`_, and ask us for help, or that we do the rebase for you 😉. + +.. _gitter: https://gitter.im/matplotlib/matplotlib diff --git a/doc/devel/saved_replies.rst b/doc/devel/saved_replies.rst new file mode 100644 index 000000000000..e5a450b26749 --- /dev/null +++ b/doc/devel/saved_replies.rst @@ -0,0 +1,53 @@ + +.. _saved_replies: + +Saved replies +============= + +To consistently maintain respectful and welcoming communication, reduce potential bias and errors, consistently provide +relevant information, and to avoid repitition, we decided to create a collection of saved replies for recurring project +needs. As a an active Matplotlib contributor, consider storing some of these responses in your GitHub account’s +`saved replies`_ as they might prove useful while reviewing issues and PRs, and otherwise supporting other community +members. Some of the suggested saved replies can be long and detailed. This is because we aim to offer support without +assuming the level of experience, or the intent the community member we are addressing might have. There is still room +to tweak and personalize your message if, for instance, some parts are redundant, require further information, or to +offer further support. Using these replies is optional. + +.. _saved replies: https://github.com/settings/replies/ + +Issues +------ + +Coming soon 😉 + +Pull Requests +------------- + +First Pull Request Merged +^^^^^^^^^^^^^^^^^^^^^^^^^ +.. code-block:: md + + Hi-five ✋ on merging your first pull request to Matplotlib, @username! We hope you stick around and invite you to + continue to take an active part in Matplotlib! Your choices aren’t limited to programming 😉 – you can review pull + requests, help us stay on top of new and old issues, develop educational material, refresh our documentation, work + on our website, and so much more! For more info, check out: https://matplotlib.org/devdocs/devel/index + + Did you know we have a monthly meeting 👥 for new contributors and a weekly meeting for the maintainers, + everyone is welcome to join both? You can find out more about our regular project meetings in this + [calendar page](https://scientific-python.org/calendars/). + + Also, consider joining our [developer mailing list](https://mail.python.org/mailman/listinfo/matplotlib-devel) ✉️. + This is a great way to connect with other people in our community and be part of important conversations that + affect the development of Matplotlib. + +Rebase +^^^^^^ +.. code-block:: md + + Hi, it looks your code needs to be rebased to include changes that have since occurred in the main repository. Would + you like to do this yourself, or would you like us to do this for you? I’m asking because a rebase can get a bit + fiddly and not everyone likes doing them 😉 + + We documented [the rebase process here](https://matplotlib.org/devdocs/devel/git_workflows#rebase.html) Have a look and + let me know how you'd like to proceed. + diff --git a/doc/devel/triage.rst b/doc/devel/triage.rst index 5f274f482f13..b236cf9ddb42 100755 --- a/doc/devel/triage.rst +++ b/doc/devel/triage.rst @@ -21,6 +21,16 @@ If you do not have enough GitHub permissions do something (e.g. add a label, close an issue), please leave a comment tagging ``@matplotlib/triageteam`` with your recommendations! +Follow the saved replies guide for detailed instructions on how to +use and contribute to our communication repository. The git workflows has a few detailed workflows which we often link +to while reviewing code. + +.. toctree:: + :maxdepth: 2 + + saved_replies.rst + git_workflows.rst + Working on issues to improve them --------------------------------- From fabd5295a3ed961cb90c6ea74703692565599cba Mon Sep 17 00:00:00 2001 From: Noa Tamir <6564007+noatamir@users.noreply.github.com> Date: Thu, 30 Jun 2022 18:51:47 +0200 Subject: [PATCH 3/3] oops. --- doc/devel/triage.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/devel/triage.rst b/doc/devel/triage.rst index 5ded93e63cd6..a61e150f1563 100755 --- a/doc/devel/triage.rst +++ b/doc/devel/triage.rst @@ -22,7 +22,6 @@ label, close an issue), please leave a comment tagging ``@matplotlib/triageteam`` with your recommendations! Follow the saved replies guide for detailed instructions on how to -<<<<<<< HEAD use and contribute to our communication repository. The git workflows has a few detailed workflows which we often link to while reviewing code. =======