The PRs welcome! badge in the READMEs of the plugins doesn't currently link to anywhere. Moreover, there doesn't appear to be guidance on where the link should direct. In a slack thread, @CEHENKLE suggested linking to the issues folder for the respective plugin, with the good first issue tag applied as a filter. However, not all plugins may have that tag, or have that tag currently applied to appropriate open issues. A campaign to implement such a tag in all plugin issue folders, and adding its link to the READMEs, could help new developers quickly identify how they can start contributing to the plugins.
In that same thread, @joshuarrrr suggested linking to the contributing guide. This could be a good alternative while discussing a campaign for the tagging system.
As a minimum though, it would be helpful to have guidance on where that badge should redirect users so that plugin owners can update their READMEs accordingly.
How did you come up with this proposal?
@cwillum noticed the missing link while addressing this README issue. Potential link options were then discussed in a slack thread.
What is the user experience going to be?
Users reading the README files in any of the plugins could click the PRs welcome! badge in the file, and would be redirected to a page with more information on how they could meaningfully contribute to the plugin.
Why should it be built? Any reason not to?
This could make it easier for developers to start contributing to these open source repositories. The blockers at the moment are that all plugin owners may not be aware that these badges are not associated with links currently, and that there doesn't seem to be guidance on where the badges should link.
What will it take to execute?
There may need to be some discussion on whether we want to go with the tag-based approach described above. If we do, there should be some guidelines for how we determine that an issue is a "good first issue." Teams would also need time to go through their issues, and apply the tag.
However, as mentioned above, linking to the contributing guide could be a good intermediary.
What are remaining open questions?
Is the good first issue an appropriate tag to link?
What are you proposing?
The
PRs welcome!badge in the READMEs of the plugins doesn't currently link to anywhere. Moreover, there doesn't appear to be guidance on where the link should direct. In a slack thread, @CEHENKLE suggested linking to theissuesfolder for the respective plugin, with thegood first issuetag applied as a filter. However, not all plugins may have that tag, or have that tag currently applied to appropriate open issues. A campaign to implement such a tag in all plugin issue folders, and adding its link to the READMEs, could help new developers quickly identify how they can start contributing to the plugins.In that same thread, @joshuarrrr suggested linking to the contributing guide. This could be a good alternative while discussing a campaign for the tagging system.
As a minimum though, it would be helpful to have guidance on where that badge should redirect users so that plugin owners can update their READMEs accordingly.
How did you come up with this proposal?
@cwillum noticed the missing link while addressing this README issue. Potential link options were then discussed in a slack thread.
What is the user experience going to be?
Users reading the README files in any of the plugins could click the
PRs welcome!badge in the file, and would be redirected to a page with more information on how they could meaningfully contribute to the plugin.Why should it be built? Any reason not to?
This could make it easier for developers to start contributing to these open source repositories. The blockers at the moment are that all plugin owners may not be aware that these badges are not associated with links currently, and that there doesn't seem to be guidance on where the badges should link.
What will it take to execute?
There may need to be some discussion on whether we want to go with the tag-based approach described above. If we do, there should be some guidelines for how we determine that an issue is a "good first issue." Teams would also need time to go through their issues, and apply the tag.
However, as mentioned above, linking to the contributing guide could be a good intermediary.
What are remaining open questions?
good first issuean appropriate tag to link?