Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a trigger for good first issues #12480

Closed
athakaras opened this issue Jun 18, 2023 · 5 comments · Fixed by nagarajan-ck/teammates#1, nagarajan-ck/teammates#3 or #12560
Closed

Add a trigger for good first issues #12480

athakaras opened this issue Jun 18, 2023 · 5 comments · Fixed by nagarajan-ck/teammates#1, nagarajan-ck/teammates#3 or #12560

Comments

@athakaras
Copy link
Contributor

Add a trigger for good first issues

  • Environment: The master branch of the repo

Description of feature/enhancement
This proposal suggests implementing a trigger by using github actions that automatically adds a comment to issues that are labeled as a "Good First Issue." The comment will provide helpful guidelines and resources for first-time contributors, useful links, and they will inform the contributor that the project does not assign issues but rather the users express their interest, by explaining the process of contribution.

Justification
Currently, when an issue is labeled as a "good first issue", there is no automated system in place to guide first-time contributors. As a result, these individuals may face difficulties understanding the project's guidelines and best practices. This lack of initial guidance can lead to delays and frustration, potentially discouraging new contributors from engaging with the project. As far as I am concerned, I also had some trouble in my first contribution and this feature would have helped me a lot. I also noticed some very popular projects doing so, that's why I think it would be a very good addition to the project's documentation.

Existing similar features and their shortcomings
The contribution documentation page of the project can be considered as exisiting similar feature, however, I think that this feature provides a faster and easier way to get the information a user needs altogether.

Please tell me if this is something that you would like to see in the project, so that I can raise the respective PR:)

@weiquu weiquu added the s.ToDiscuss The issue/PR is undergoing discussion/review by the core team label Jun 18, 2023
@weiquu
Copy link
Contributor

weiquu commented Jun 18, 2023

Thanks @athakaras for the suggestion! I think this idea makes sense (: While we wait for other contributors to weigh in, could you provide some examples of guidelines, resources, and links the comment would contain? I assume it would have links to the contribution / workflow page, but I'm not sure what else

@athakaras
Copy link
Contributor Author

@weiquu sure! I haven't thought of what the comment will entail 100% but I was thinking something like the following:

Good First Issue - notes for new contributors

This issue is for new contributors only, so if you are new feel free to submit your pull request. Please note that we allow only one good first issue per contributor to give the opportunity to all contributors to practise.

To get started please read carefully our contributing guidelines

We do not assign issues. Please note that the team does not assign issues to individuals. If you want to take on an issue, simply state your interest in the comment section of the issue and a team member will answer shortly :)

If something is unclear or you need help, please post a message in our discussion forum

This is what I have thought so far to include in the comment. If you want me to add something or modify something else please let me know by all means!

@zhaojj2209
Copy link
Contributor

Thanks for the suggestion, this was something I wanted to work on but didn't get around to doing. Feel free to submit a PR for this!

Have added a few things to the comment, other maintainers feel free to chip in as well.

**Good First Issue - Notes for Contributors**

This issue is for **first-time contributors only**. If you are new to TEAMMATES, feel free to submit a PR for this issue. 

*Please note that we allow only one `good first issue` per contributor.* If you have already made a prior contribution to TEAMMATES, you may wish to take a look at issues with the `help wanted` tag instead.

**We do not assign issues to contributors**. If you would like to pick up this issue, do post a comment below to express your interest and check if there is anyone else who is already working on the issue. We will do our best to reply and give you the go-ahead, but if we don't, feel free to submit a PR as long as there is no one else working on it.

**To get started**, do read through our [contributing guidelines](https://teammates.github.io/teammates/contributing-doc.html) carefully, and [set up a development environment on your local machine](https://teammates.github.io/teammates/setting-up.html) before making a PR.

If you need any clarifications on our [developer guide](https://teammates.github.io/teammates/index.html), or are facing issues that are not found in our [troubleshooting guide](https://teammates.github.io/teammates/troubleshooting-guide.html), please [post a message in our discussion forum](https://github.com/TEAMMATES/teammates/discussions).

@weiquu weiquu removed the s.ToDiscuss The issue/PR is undergoing discussion/review by the core team label Jun 19, 2023
@athakaras
Copy link
Contributor Author

@zhaojj2209 i am raising a PR! Please let me know if it is okay:)

@nagarajan-ck
Copy link
Contributor

Hi @zhaojj2209

I have raised a PR resolving the error that was there earlier. I am able to see the comment for good first issues in my own repo.
Screenshot

zhaojj2209 added a commit that referenced this issue Sep 16, 2023
* add good first issue yaml file

* remove error: context.issue is not a function

* github.issues.createComment in V4 becomes github.rest.issues.createComment in V5

* change message to be TEAMMATES specific

* resolve unexpected identifier issue

* put messages in seperate lines

* put messages in env variable

* put 2 whitespaces for a newline

* Add new lines between message

* Update comment-goodfirstissue.yml

* Add 2 lines

* add 3rd and 4th line

* put message in body variable

* change github actions version from v5 to v6

* Simplify good first issue yaml file

Co-authored-by: Zhao Jingjing <[email protected]>

---------

Co-authored-by: Zhao Jingjing <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment