Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 2.63 KB
Raw
layout
default

Contributing Guide

Welcome to our community! We're excited to hear and learn from you.

We've put together the following guidelines to help you figure out where you can best be helpful.

Table of Contents

  1. Types of contributions we're looking for
  2. Ground rules & expectations
  3. How to contribute

Types of contributions we're looking for

There are many ways you can contribute (in descending order of need):

  • Fix editorial inconsistencies or inaccuracies
  • Add stories, examples, or anecdotes that help illustrate a point
  • Revise language to be more approachable and friendly
  • Translate documents into other languages

Interested in making a contribution? Read on!

Ground rules & expectations

Before we get started, here are a few things we expect from you (and that you should expect from others):

  • Be kind and thoughtful in your conversations around this project. We all come from different backgrounds and projects, which means we likely have different perspectives on "how open source is done." Try to listen to others rather than convince them that your way is correct.
  • Please read the Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.
  • When you open a pull request, please ensure that your contribution passes all tests. If there are test failures, you will need to address them before we can merge your contribution.
  • When adding content, please consider if it is widely valuable. Please don't add references or links to things you or your employer have created as others will do so if they appreciate it.

How to contribute

If you'd like to contribute, start by searching through the each repository's issues and pull requests to see whether someone else has raised a similar idea or question.

If you don't see your idea listed, and you think it fits into the goals of this project, do one of the following:

  • If your contribution is minor, such as a typo fix, open a pull request.
  • If your contribution is major, such as a new idea, start by opening an issue, email, or any other method first with the owners. That way, other people can weigh in on the discussion before you do any work.

When processing a pull request, see how to open a pull request(Korean)

You can find more information on repositories. To contact with our community and ask questions, please join the Slack workspace and channels