Commit 08ef04d
committed
Update documentation
Make various updates to reflect the current state of the project.1 parent 2405f13 commit 08ef04d
4 files changed
Lines changed: 4 additions & 63 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -19,15 +19,12 @@ We've put together the following guidelines to help you figure out where you can | |||
| 19 | 19 | 0. [Community](#community) | |
| 20 | 20 | ||
| 21 | 21 | ## Types of contributions we're looking for | |
| 22 | - First and foremost, this project is a forum to discuss open source best practices, then document them in a guide when we've found consensus. Your first contribution might be starting a new conversation, or adding to an existing conversation, around best practices. You can do so under [Issues](https://github.com/github/opensource.guide/issues). | ||
| 23 | - | ||
| 24 | - There are also many ways you can directly contribute to the guides (in descending order of need): | ||
| 22 | + There are many ways you can directly contribute to the guides (in descending order of need): | ||
| 25 | 23 | ||
| 26 | 24 | * Fix editorial inconsistencies or inaccuracies | |
| 27 | 25 | * Add stories, examples, or anecdotes that help illustrate a point | |
| 28 | 26 | * Revise language to be more approachable and friendly | |
| 29 | 27 | * [Translate guides into other languages](docs/translations.md) | |
| 30 | - * Propose a new guide ([here's how](./docs/new-guides.md)) | ||
| 31 | 28 | ||
| 32 | 29 | Interested in making a contribution? Read on! | |
| 33 | 30 | ||
@@ -64,7 +61,7 @@ Once you have that set up, run: | |||
| 64 | 61 | ||
| 65 | 62 | ## Contribution review process | |
| 66 | 63 | ||
| 67 | - This repo is currently maintained by @nayafia and @bkeepers, who have commit access. They will likely review your contribution. If you haven't heard from anyone in 10 days, feel free to bump the thread or @-mention a maintainer to review your contribution. | ||
| 64 | + This repo is currently maintained by @nayafia and @mikemcquaid, who have commit access. They will likely review your contribution. If you haven't heard from anyone in 10 days, feel free to bump the thread or @-mention a maintainer to review your contribution. | ||
| 68 | 65 | ||
| 69 | 66 | ## Community | |
| 70 | 67 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -5,19 +5,13 @@ | |||
| 5 | 5 | Open Source Guides (https://opensource.guide/) are a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project. | |
| 6 | 6 | ||
| 7 | 7 | ## Background | |
| 8 | - The first set of Open Source Guides were created and curated by GitHub, along with input from outside community reviewers, but they are not exclusive to GitHub products. | ||
| 8 | + Open Source Guides were created and are curated by GitHub, along with input from outside community reviewers, but they are not exclusive to GitHub products. One reason we started this project is because we felt that there weren't enough resources for people creating open source projects. | ||
| 9 | 9 | ||
| 10 | 10 | Our goal is to aggregate 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. | |
| 11 | 11 | ||
| 12 | - **Open Source Guides are a resource and a discussion forum.** One reason we started this project is because we felt that there weren't enough resources for people creating open source projects. We made these guides open source in hopes that you'll use this space to talk about best practices, then document them when you've found consensus. We'd like this to be a safe space to talk about what's hard, what's scary, and what's simply confusing about running open source projects. | ||
| 13 | - | ||
| 14 | - ## Roadmap | ||
| 15 | - | ||
| 16 | - We've shared our vision and priorities for this project in our [roadmap](docs/roadmap.md). | ||
| 17 | - | ||
| 18 | 12 | ## Contributing | |
| 19 | 13 | ||
| 20 | - This site is powered by [Jekyll](https://jekyllrb.com/). Our goal is for this project to reflect community best practices, so we'd love your input! Got a question or an idea? Check out our [contributing guidelines](/CONTRIBUTING.md) for ways to offer feedback and contribute. | ||
| 14 | + This site is powered by [Jekyll](https://jekyllrb.com/). Check out our [contributing guidelines](/CONTRIBUTING.md) for ways to offer feedback and contribute. | ||
| 21 | 15 | ||
| 22 | 16 | ## Licenses | |
| 23 | 17 | ||
This file was deleted.
This file was deleted.
0 commit comments