Feature: Add reminder for contributors to fill out the whole PR template in lesson 05.
Haimantika opened this issue · comments
Type of feature
🍕 Feature
Current behavior
In lesson 05 of the course, where contributors are adding themself to the guestbook, there is no reminder for contributors to fill out the issue template completely and this is something that one can miss. It will be nice to add a point about it.
Suggested solution
- Go to lesson 05- how-to-contribute-to-open-source, under Let’s get practical.
- Make the following changes in point 11 👇
11. Go to your forked repository on GitHub. Create a pull request with the title `feat: Add <@github-username> as a contributor` and fill in all areas in the pull request form.
!> Your pull request will be marked as invalid and may be closed if the form is incomplete.
Additional context
No response
Code of Conduct
- I agree to follow this project's Code of Conduct
Contributing Docs
- I agree to follow this project's Contribution Docs
Hi @Haimantika. Point 7 does mention fill out the required information, so I’m not sure if adding the note is necessary. What do you think @adiati98?
Hi @CBID2 it does say to fill in the required information, yet I missed filling the description, and there might be more contributors who miss it. So either a note or in the same line if we can mention in bold to fill all information, it will be helpful. Let me know what you think is better.
Hi,
I think Haimantika has a point here, it would be useful for very new contributors if there was an explicit point on issue templates and the importance/why they should be filled in completely.
@Haimantika thanks for raising this issue! 🙌
I think this is a good idea. ✨
However, I have another thought for this that I need to think through.
I see that the same issue is going on around open source and not only here. Folks are not completing PR forms, even with explicit instructions.
For now, I see a chance to update point 11 in "Let's Get Practical" section because I believe folks are following this tutorial to contribute to the guestbook repo.
intro/05-how-to-contribute-to-open-source.md
Line 172 in 67c7526
If you can update this issue to address it, that would be great.
We can update it as follow:
11. Go to your forked repository on GitHub. Create a pull request with the title `feat: Add <@github-username> as a contributor` and fill in all areas in the pull request form.
!> Your pull request will be marked as invalid and may be closed if the form is incomplete.@Haimantika thanks for raising this issue! 🙌
I think this is a good idea. ✨ However, I have another thought for this that I need to think through.
I see that the same issue is going on around open source and not only here. Folks are not completing PR forms, even with explicit instructions.
For now, I see a chance to update point 11 in "Let's Get Practical" section because I believe folks are following this tutorial to contribute to the guestbook repo.
intro/05-how-to-contribute-to-open-source.md
Line 172 in 67c7526
If you can update this issue to address it, that would be great.
We can update it as follow:
11. Go to your forked repository on GitHub. Create a pull request with the title `feat: Add <@github-username> as a contributor` and fill in all areas in the pull request form. !> Your pull request will be marked as invalid and may be closed if the form is incomplete.
Yes! This is a great suggestion. Thanks. Will update the issue accordingly.
@adiati98 made the changes in the issue. Let me know what you think.
@adiati98 made the changes in the issue. Let me know what you think.
As I mentioned in my comment, can you please change the "Contributor Workflow" section to "Let's Get Practical"? And give indentation for the last sentence, as it would be part of the point 11. Thanks, @Haimantika!
Hi @CBID2 ,
Thank you for your prompt action! 😊
For your future reference, we want to first ask contributor if they want to work on the issue before assigning, even if they're the one who created it. There are cases where contributors are creating issues to address something but don't have the intention to work on it. 🙂
As there's a request to update the issue, it would be great to wait until the issue is updated before removing the needs triage label.