Skip to content

Latest commit

 

History

History
59 lines (31 loc) · 4.04 KB

contributing.md

File metadata and controls

59 lines (31 loc) · 4.04 KB
Raw

How to contribute

Overview

So You Just Learned is an open source collection of resources designed as an entry point for people just learning about inequity in the tech industry. This is not meant to act as a comprehensive guide. It is, however, a good jumping off point for people who want to learn more in good faith.

This document aims to reduce the emotional labor of marginalized people in tech. Having to rehash grievances and repeatedly explain marginalization and bias is an unhealthy emotional burden. This contributes to animosity and burnout within the tech industry. This project is a small step forward toward alleviating some of that burden.

What belongs in this project?

  1. Resources for understanding emotional labor and marginalization in the tech industry

  2. Links to first person accounts of marginalization in the tech industry

  3. Links to resources and organizations that support marginalized people that need donations and/or volunteer work.

What do I need to contribute?

This project is hosted on Github, so a working knowledge of git is useful. However, the core contributors are happy to talk about this process through issues and pull requests if you are just learning about git and contributing to Open Source. So You Just Learned is committed to being an open and inclusive environment, and is a great place to practice your skills and submit your first pull request!

So You Just Learned has adopted the Contributor Covenant v 1.4 as our governing Code of Conduct. By submitting a pull request to this project, you are agreeing to abide by the Contributor Covenant.

Steps to Contribute

Create your own fork of the repo.

Make changes in a local branch and open a pull request from your fork to the parent repo's master branch.

This resource currently exists as a series of markdown files. For more information on Github flavored markdown, check out their handy guide.

We track discussions and potential additions to the repo via the issue tracker on the github repo. We label issues in a way that will help you make your first contribution to the project.

When you submit your pull request, please be descriptive in your commit messages and PR titles :)

Maintainers of the repo will review the resources linked in your pull request. When your pull request is approved we will squash and merge the commits.

Issue Labels

  • good for new folks: We welcome new contributors to help with any issue, and we've tagged some issues as specifically being easily approachable for new contributors. These might include adding links, fixing typos, or other small changes that don't require lots of discussion.

  • discussion requested: This means that someone would like to have a discussion about an issue proposed to the project. This might include discussing the best way compassionately tackle a current event or how to approach including a new link, for example.

Pull Request Submission and Review Process

  1. When you submit a PR, include any relevant issue numbers either in the title or the PR description.

  2. @mention all of the maintainers in your PR description to make sure we see it!

  3. When 2/3 of the maintainers approve the pull request, we will merge it in.

    a. If we request changes to your PR, we'll usually be pretty specific or invite further discussion. If you're confused about any of the review notes on your pull request, don't be shy about asking for clarification or pushing back. We love healthy discussion. Just be sure to keep our code of conduct in mind.

Thank you for your interest in contributing to this project. If you found it useful, please share it far and wide.

Maintainers