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.

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

[WIP]Update CONTRIBUTING.md #438

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

Conversation

GeorgiaHCA
Copy link
Collaborator

Summary

I created new labels based on feedbacak from Sue. This is an update to the contributing guidelines to reflect them.

@GeorgiaHCA
Copy link
Collaborator Author

In the Turing Way contributors doc there are images of issues which link back to the issues in the repo. It would be awesome to have those for this repo, but I'm not sure how to create it.
Perhaps you could help @sgibson91 or @malvikasharan ?

@GeorgiaHCA GeorgiaHCA added Accessibility and Inclusion How to ensure that we have a diverse, inclusive community and reach those not in the room right now community Building a healthy community help wanted Extra attention is needed Intermediate This issue is suitable for someone with some knowledge of the project and with GitHub Repository Getting the project's repositories in an up-to-date, accessible, well-designed state tech-skills-req Actions that require some technical expertise labels Mar 18, 2021
@GeorgiaHCA GeorgiaHCA self-assigned this Mar 18, 2021
@sgibson91
Copy link
Collaborator

In the Turing Way contributors doc there are images of issues which link back to the issues in the repo. It would be awesome to have those for this repo, but I'm not sure how to create it.
Perhaps you could help @sgibson91 or @malvikasharan ?

Hey Georgia! So to get the issue labels that link back to the issue board there's a few steps.

  1. Use sheilds.io's issue label generator to make the shields. The user field is alan-turing-institute, repo field is AutisticaCitizenScience, and the label field is whichever label you'd like to create a shield for. It should create a URL that looks like this:
    ![GitHub labels](https://img.shields.io/github/labels/alan-turing-institute/AutisticaCitizenScience/<LABEL-NAME-HERE>)

  2. Get the GitHub link to the issues that match that label. You can do this by clicking on a label on a GitHub page, and copying the URL you're redirected to from your browser. It should look something like this:
    https://github.com/alan-turing-institute/AutisticaCitizenScience/labels/<LABEL-NAME-HERE>
    Note: If your label contains a space, e.g. help wanted, then that space should be replaced by a %20 sign in the URL, e.g. https://github.com/alan-turing-institute/AutisticaCitizenScience/labels/help%20wanted

  3. Create your link! This is going to take the following form
    [CONTENT FROM STEP 1](CONTENT FROM STEP 2)
    So an example for the community label looks like this:
    [![GitHub labels](https://img.shields.io/github/labels/alan-turing-institute/AutisticaCitizenScience/community)](https://github.com/alan-turing-institute/AutisticaCitizenScience/labels/community)
    which renders as:
    GitHub labels

Hope this helps! 🌺

Copy link
Collaborator

@sgibson91 sgibson91 left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀 🌺 ✨

If you know how to fix the bug, please open an issue first and then submit a pull request :sparkles:

- [![project-management](https://img.shields.io/badge/-project%20management-bfd86c.svg)][labels-project-management] _These issues help us to coordinate some project logistics._
[![good-first-issue](https://img.shields.io/badge/-good%20first%20issue-1b3487.svg)][labels-firstissue] _These issues are particularly appropriate if it is your first contribution to _Thee Autistica/Turing citizens science project_, or to GitHub overall.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
[![good-first-issue](https://img.shields.io/badge/-good%20first%20issue-1b3487.svg)][labels-firstissue] _These issues are particularly appropriate if it is your first contribution to _Thee Autistica/Turing citizens science project_, or to GitHub overall.
[![good-first-issue](https://img.shields.io/badge/-good%20first%20issue-1b3487.svg)][labels-firstissue] _These issues are particularly appropriate if it is your first contribution to the **Autistica/Turing citizens science project**, or to GitHub overall._

Some minor formatting cleanup

@BrainonSilicon BrainonSilicon self-requested a review October 6, 2021 15:01
@BrainonSilicon
Copy link
Member

Hey @GeorgiaHCA! I just wanted to check if this was still an active feature we wanted for the project ⭐

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accessibility and Inclusion How to ensure that we have a diverse, inclusive community and reach those not in the room right now community Building a healthy community help wanted Extra attention is needed Intermediate This issue is suitable for someone with some knowledge of the project and with GitHub Repository Getting the project's repositories in an up-to-date, accessible, well-designed state tech-skills-req Actions that require some technical expertise
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update guide to issues
3 participants