From 9e05b0491f1bd27e7fb1ec0aa964a8c4086214aa Mon Sep 17 00:00:00 2001 From: Marc Garcia Date: Fri, 15 Nov 2019 21:10:11 +0000 Subject: [PATCH 1/5] CI: Adding GitHub action to assign issues based on comment --- .github/workflows/assign.yml | 15 +++++++++++++++ doc/source/development/contributing.rst | 10 ++++++++++ 2 files changed, 25 insertions(+) create mode 100644 .github/workflows/assign.yml diff --git a/.github/workflows/assign.yml b/.github/workflows/assign.yml new file mode 100644 index 0000000000000..019ecfc484ca5 --- /dev/null +++ b/.github/workflows/assign.yml @@ -0,0 +1,15 @@ +name: Assign +on: + issue_comment: + types: created + +jobs: + one: + runs-on: ubuntu-latest + steps: + - name: + run: | + if [[ "${{ github.event.comment.body }}" == "take" ]]; then + echo "Assigning issue ${{ github.event.issue.number }} to ${{ github.event.comment.user.login }}" + curl -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" -d '{"assignees": ["${{ github.event.comment.user.login }}"]}' https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.issue.number }}/assignees + fi diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 8fe5b174c77d3..e0356d4667b18 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -24,6 +24,16 @@ and `good first issue where you could start out. Once you've found an interesting issue, you can return here to get your development environment setup. +When you start working on an issue, it's a good idea to assign the issue to yourself, +so nobody else diplicates the work on it. GitHub restricts assigning issues to maintainers +of the project only. Until recently, contributors added a comment letting others know they +are working on an issue. But we implemented a workaround consisting of adding +a comment with the exact text `take`. When you do it, a GitHub action will automatically assign +you the issue few seconds later. This way, it's possible to filter the list of issues, and find +only the unassigned ones. Work on assigned issues can be discontinued. Feel free to also +consider assigned issues. Just kindly ask the current assignee if you can take an issue, +if it's been inactive for some time (a week at least). + Feel free to ask questions on the `mailing list `_ or on `Gitter`_. From ccf0d226c945ea30ac8ea7a78646344f8e6fb2d5 Mon Sep 17 00:00:00 2001 From: Marc Garcia Date: Fri, 15 Nov 2019 21:53:35 +0000 Subject: [PATCH 2/5] Typo --- doc/source/development/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index e0356d4667b18..d3029cd337511 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -25,7 +25,7 @@ where you could start out. Once you've found an interesting issue, you can return here to get your development environment setup. When you start working on an issue, it's a good idea to assign the issue to yourself, -so nobody else diplicates the work on it. GitHub restricts assigning issues to maintainers +so nobody else duplicates the work on it. GitHub restricts assigning issues to maintainers of the project only. Until recently, contributors added a comment letting others know they are working on an issue. But we implemented a workaround consisting of adding a comment with the exact text `take`. When you do it, a GitHub action will automatically assign From 84acf9a270f193bad3f3c8bd98608176d9bf90b5 Mon Sep 17 00:00:00 2001 From: Marc Garcia Date: Sat, 16 Nov 2019 02:41:10 +0000 Subject: [PATCH 3/5] Update doc/source/development/contributing.rst Co-Authored-By: gfyoung --- doc/source/development/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index d3029cd337511..422483a9e4e25 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -29,7 +29,7 @@ so nobody else duplicates the work on it. GitHub restricts assigning issues to m of the project only. Until recently, contributors added a comment letting others know they are working on an issue. But we implemented a workaround consisting of adding a comment with the exact text `take`. When you do it, a GitHub action will automatically assign -you the issue few seconds later. This way, it's possible to filter the list of issues, and find +you the issue a few seconds later. This way, it's possible to filter the list of issues and find only the unassigned ones. Work on assigned issues can be discontinued. Feel free to also consider assigned issues. Just kindly ask the current assignee if you can take an issue, if it's been inactive for some time (a week at least). From 2be96f11d96000d64b169ec449a04d08f9418fbb Mon Sep 17 00:00:00 2001 From: Marc Garcia Date: Sat, 16 Nov 2019 18:15:11 +0000 Subject: [PATCH 4/5] Better documentation (splitting in several paragraphs) --- doc/source/development/contributing.rst | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 422483a9e4e25..06368a90589ac 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -26,13 +26,24 @@ return here to get your development environment setup. When you start working on an issue, it's a good idea to assign the issue to yourself, so nobody else duplicates the work on it. GitHub restricts assigning issues to maintainers -of the project only. Until recently, contributors added a comment letting others know they -are working on an issue. But we implemented a workaround consisting of adding -a comment with the exact text `take`. When you do it, a GitHub action will automatically assign -you the issue a few seconds later. This way, it's possible to filter the list of issues and find -only the unassigned ones. Work on assigned issues can be discontinued. Feel free to also -consider assigned issues. Just kindly ask the current assignee if you can take an issue, -if it's been inactive for some time (a week at least). +of the project only. In most projects, and until recently in pandas, contributors added a +comment letting others know they are working on an issue. While this is ok, you need to +check each issue individually, and it's not possible to find the unassigned ones. + +For this reason, we implemented a workaround consisting of adding a comment with the exact +text `take`. When you do it, a GitHub action will automatically assign you the issue +(this will take seconds, and may require refreshint the page to see it). +By doing this, it's possible to filter the list of issues and find only the unassigned ones. + +So, a good way to find an issue to start contributing to pandas is to check the list of +`unassigned good first issues `_ +and assign yourself one you like by writing a comment with the exact text `take`. + +If for whatever reason you are not able to continue working with the issue, please try to +unassign it, so other people know it's available again. You can check the list of +assigned issues, since people may not be working in them anymore. If you want to work on one +that is assigned, feel free to kindly ask the current assignee if you can take it +(please allow at least a week on inactivity before considering work in the issue can be discontinued). Feel free to ask questions on the `mailing list `_ or on `Gitter`_. From 457125c4bdafa012408de039d8d1960a76834088 Mon Sep 17 00:00:00 2001 From: Marc Garcia Date: Sun, 17 Nov 2019 02:11:11 +0000 Subject: [PATCH 5/5] Update doc/source/development/contributing.rst Co-Authored-By: gfyoung --- doc/source/development/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 06368a90589ac..553b167034350 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -43,7 +43,7 @@ If for whatever reason you are not able to continue working with the issue, plea unassign it, so other people know it's available again. You can check the list of assigned issues, since people may not be working in them anymore. If you want to work on one that is assigned, feel free to kindly ask the current assignee if you can take it -(please allow at least a week on inactivity before considering work in the issue can be discontinued). +(please allow at least a week of inactivity before considering work in the issue discontinued). Feel free to ask questions on the `mailing list `_ or on `Gitter`_.