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.

Sign up for GitHub

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

Update CONTRIBUTE.md to explain Badges #921

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Update CONTRIBUTE.md to explain Badges #921

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 29 additions & 2 deletions CONTRIBUTE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,35 @@ Before making a contribution, please take the following steps:

NOTE: All contributors must have a contributor license agreement (CLA) on file with FINOS before their pull requests will be merged. Please review the FINOS [contribution requirements](https://community.finos.org/docs/governance/Software-Projects/contribution-compliance-requirements) and submit (or have your employer submit) the required CLA before submitting a pull request.

### Linux Foundation Badges for Theme Builder contributors and community champions

- Theme Builder [maintainers](/MAINTAINERS.md) are able to nominate community members for badges that are
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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

- 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

through speaking, blogging/vlogging, social media and community engagement
- In order to receive a badge, a maintainer must add the nominee(s) to a private channel in the FINOS
Slack for Theme Builder badge nominees.
- This enables a private process of collecting First Name, Last Name, desired email for digital badging,
and home country, state/province.
- *Please do not post your personal information in the private Slack channel; reach out via private
direct message to a maintainer to exchange the information.*
- 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 'help@finos.org' and request an invitation._
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 'help@finos.org' 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.

- Nomintations are submitted to the Linux Foundation on or about the first working day of each month, for
new badges earned in the previous month.
- Nominees added to the private badging channel in the FINOS Slack may use that channel for questions
about badging or issues with badge receipt.

## Team members

Meet and join our [Team of Contributors](https://github.com/finos/a11y-theme-builder/wiki/Maintainers-&-Contributors).
Meet and join our [Team of Maintainers](/MAINTAINERS.md).

## Learn & listen
<!-- Fill out Missing Project Communications -->
Expand All @@ -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 'help@finos.org' and request an invitation.
The public FINOS Slack channel for Theme Builder collaboration is #a11y-theme-builder.
* Blog/Wiki
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

* Link: https://github.com/finos/a11y-theme-builder/wiki

Expand Down