Update CONTRIBUTE.md to explain Badges #921
Conversation
Added a section to describe the Theme Builder badging process and eligibility to be nominated for a Theme Builder badge, to close out finos#786
✅ Deploy Preview for glistening-gecko-6b417a ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| issued by the Linux Foundation. | ||
| - For details, descriptions and designs for these badges are provided in | ||
| [issue #786](https://github.com/finos/a11y-theme-builder/issues/786). | ||
| - Community members can be nominated for badges when: |
There was a problem hiding this comment.
Since this is documentation, we probably shouldn't be referencing an issue except, maybe, to give background information where it is important to attribute history to those involved. There is a lot of other stuff to wade through in the issue. If this is important for the user to see (e.g. the design and descriptions), and it probably is, maybe we should post the design, description, etc. somewhere else? Like maybe in the Wiki and link to it from here?
| - Community members can be nominated for badges when: | ||
| - your first pull request has been merged for contributions to code, design, or documentation, and/or | ||
| - you have been active in community building efforts, including contributing to project issues tagged | ||
| with the 'community' label and/or raising awareness and bringing new contributors to Theme Builder |
There was a problem hiding this comment.
Maybe break out design into its own bullet? Because a design isn't submitted via pull request and there is very little a designer can do to affect a PR unless they are also able to implement it.
Also, do we want to award a badge to those that participate in the community but not necessarily community building? For example, someone who participates in our calls, comments on issues, brings insight and leadership (e.g. a project lead person) or testing but not necessarily doing contributions or bringing more eyes to Theme Builder. Maybe make this second bullet more general, like "you have been active in the community" and then have two or more sub-bullets under THAT where we give examples of how someone can make valuable contributions to the community without code, design or documentation changes.
| - This information is collected privately by the maintainer in order to submit nominees to the Linux | ||
| Foundation for badging. | ||
| - NOTE: _If you are interested in joining the FINOS Slack and collaborating with the Theme Builder | ||
| team on the project's public channel, please send an email to '[email protected]' and request an invitation._ |
There was a problem hiding this comment.
With this last note, it sounds like joining the FINOS Slack is optional for getting a badge or that joining the "public" Slack channel is separate from the private channel. If they want to provide their information to us using any Slack channel they have to join FINOS Slack.
Maybe break this apart into Slack and non-Slack routes. Like have a note here like you do that has:
- NOTE: _This path requires that you be a participant in FINOS Slack. If you are not already, you can join by sending an email to '[email protected]' and requesting an invitation to join the Accessibility Theme Builder public channel. This will also allow you to collaborate with other community members _
Maybe have another bullet at the same level as the bullet on line 63 after the above section that describes how to get the badge if they are not interested in joining Slack. We'd probably need some kind of an email path that is initiated by the contributor or a maintainer that reaches out to the contributor via GitHub.
| @@ -62,7 +88,8 @@ This section includes ways to get started with your open source project. Include | |||
| * Link: https://github.com/finos/a11y-theme-builder/discussions | |||
| * Slack | |||
| * Used for questions to project maintainers or for private chat. | |||
| * Link: https://join.slack.com/t/finos-lf/shared_invite/zt-24pxubwxi-vKczbM0pWYnltCRoOCDpFQ | |||
| * To join the FINOS Slack, email '[email protected]' and request an invitation. | |||
| The public FINOS Slack channel for Theme Builder collaboration is #a11y-theme-builder. | |||
| * Blog/Wiki | |||
There was a problem hiding this comment.
You mention here "request an invitation". But should this be more specific? If they do this without providing any other information I'm guessing that they'll just be plopped into Slack and then still have to ask us to join the channel. Should they be requesting an invitation to join #a11y-theme-builder channel? Just wondering if FINOS will go ahead and place them in the channel after the invitation is accepted if they request that specifically. Since I was placed into the group specifically, I didn't really go this route so not sure if I'm worrying about nothing (e.g. user being in Slack but we don't know that they want to be in Theme Builder...having this disconnect is my worry).
Added a section to describe the Theme Builder badging process and eligibility to be nominated for a Theme Builder badge, to close out #786