-
Notifications
You must be signed in to change notification settings - Fork 3.3k
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
Add a trigger for good first issues #12480
Comments
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 |
@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! |
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.
|
@zhaojj2209 i am raising a PR! Please let me know if it is okay:) |
[TEAMMATES#12480] add good first issue yaml file
[TEAMMATES#12480] remove error: context.issue is not a function
[TEAMMATES#12480] change github.issues.createComment to github.rest.issues.createComment
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. |
* 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]>
Add a trigger for good first issues
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:)
The text was updated successfully, but these errors were encountered: