Skip to content

Commit 8f8992d

Browse files
author
Nadia Eghbal
authored
incorporate edits
1 parent c6a35f8 commit 8f8992d

File tree

1 file changed

+18
-20
lines changed

1 file changed

+18
-20
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,27 @@ Thanks for checking out the Open Source Handbook! We're excited to hear and lear
55
We've put together the following guidelines to: 1) communicate the goals of this project and 2) help you figure out where you can best be helpful.
66

77
## Table of Contents
8-
List all the headings here
8+
1. [Goals of this project](#goals-of-this-project)
9+
2. [Types of contributions we're looking for](#types-of-contributions-were-looking-for)
10+
3. [Ground rules & expectations](#ground-rules--expectations)
11+
4. [How to contribute](#how-to-contribute)
12+
5. [Setting up your environment](#setting-up-your-environment)
13+
6. [Contribution review process](#contribution-review-process)
14+
7. [Community](#community)
915

1016
## Goals of this project
1117

12-
We created this Handbook for individuals, communities and companies that want to successfully run and maintain an open source project. The content was originally created and curated by GitHub, along with input from outside community reviewers, but it is not specific to GitHub products.
18+
We created this Handbook for individuals, communities, and companies that want to successfully run and maintain an open source project. The content was originally created and curated by GitHub, along with input from outside community reviewers, but it is not specific to GitHub products.
1319

1420
Here are some guiding principles for the Handbook:
1521

1622
* **Approachability:** Don't assume reader has prior knowledge
1723
* **Brevity:** Keep it simple, link to outside content for deeper dives
18-
* **Curation:** Amplify community best practices vs. any individual's POV
24+
* **Curation:** Amplify community best practices vs. any individual's point of view
1925

20-
This Handbook is a jumping off point for people who want to familiarize themselves with running an open source project. It should give readers enough information to get started, but it doesn't attempt to answer everything in detail.
26+
This Handbook is a jumping off point for people who want to learn how to run an open source project. It should give readers enough information to get started, but it doesn't attempt to answer everything in detail.
2127

22-
This Handbook also aggregates community best practices, *not* what GitHub (or any other individual or entity) thinks is best. Therefore, we try to use examples and quotations from others to illustrate our points. Many sections also link to "Further Reading" at the end, to surface relevant writing and perspectives that lives elsewhere on the web.
28+
This Handbook also aggregates community best practices, *not* what GitHub (or any other individual or entity) thinks is best. Therefore, we try to use examples and quotations from others to illustrate our points. Many sections also link to "Further Reading" at the end, to surface relevant writing and perspectives that live elsewhere on the web.
2329

2430
## Types of contributions we're looking for
2531

@@ -33,19 +39,17 @@ There are many ways you can contribute to the Handbook:
3339

3440
Interested in making a contribution? Read on!
3541

36-
(should we call out anything we're NOT looking for here? would we accept design or code contributions?)
37-
3842
## Ground rules & expectations
3943

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

42-
* 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.
46+
* 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.
4347
* This Handbook is released with a [Contributor Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
44-
* (anything we want to call out around testing?)
48+
* If 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.
4549

46-
## How to make a contribution
50+
## How to contribute
4751

48-
If you're interested in contributing, start by searching through the [issues](https://github.com/github/open-source-handbook/issues) and [pull requests](https://github.com/github/open-source-handbook/pulls) to see whether someone else has raised a similar idea or question.
52+
If you'd like to contribute, start by searching through the [issues](https://github.com/github/open-source-handbook/issues) and [pull requests](https://github.com/github/open-source-handbook/pulls) to see whether someone else has raised a similar idea or question.
4953

5054
If you don't see your idea listed, and you think it fits into the goals of this handbook, do one of the following:
5155
* **If your contribution is minor,** such as a typo fix, you can make the change and open a pull request.
@@ -62,22 +66,16 @@ Once you have that set up, run:
6266

6367
…and open http://localhost:4000 in your web browser.
6468

65-
## Bug reports and security disclosures
66-
67-
(do we need to include for this project?)
68-
6969
## Contribution review process
7070

7171
This repo is currently maintained by @nayafia and @bkeepers, who have commit access. They will likely review your contribution.
7272

7373
While we enjoy maintaining this project and are excited that you want to participate, we have full-time jobs and competing priorities. If you haven't heard from anyone in 10 days, feel free to bump the thread or @-mention a maintainer to review your contribution.
7474

75-
If you've been active on this project (such as writing helpful content, answering others' questions, or triaging issues) and would like a more formal leadership role, open up an issue, and let's talk about it!
75+
If you've been active on this project (such as writing helpful content, answering others' questions, or triaging issues) and would like a more formal leadership role, open up an issue and let's talk about it!
7676

7777
## Community
7878

79-
Handbook discussions take place on this repository's [Issues](https://github.com/github/open-source-handbook/issues) and [Pull Requests](https://github.com/github/open-source-handbook/pulls) sections. Anybody is welcome to join these conversations.
80-
81-
There is also a mailing list for regular updates and discussion (link to mailing list)
79+
Handbook discussions take place on this repository's [Issues](https://github.com/github/open-source-handbook/issues) and [Pull Requests](https://github.com/github/open-source-handbook/pulls) sections. Anybody is welcome to join these conversations. There is also a mailing list for regular updates and discussion.
8280

83-
Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Not only will you stress them out, but keeping communication public means everybody can benefit and learn from the conversation.
81+
Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Keeping communication public means everybody can benefit and learn from the conversation.

0 commit comments

Comments
 (0)