Skip to content

Commit fc67e42

Browse files
author
Nadia Eghbal
authored
Merge pull request #362 from github/new-guides
Proposed process for writing new guides
2 parents aeeef2b + b6e8584 commit fc67e42

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ There are also many ways you can directly contribute to the guides (in descendin
2727
* Add stories, examples, or anecdotes that help illustrate a point
2828
* Revise language to be more approachable and friendly
2929
* Translate guides into other languages
30-
* Propose a new guide (please open an issue to discuss before writing!)
30+
* Propose a new guide ([here's how](./docs/new-guides.md))
3131

3232
Interested in making a contribution? Read on!
3333

docs/new-guides.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Proposing a new guide
2+
3+
Thanks for your interest in suggesting a new Open Source Guide! Your suggestions help us decide what to work on next.
4+
5+
## If you'd like to propose a new guide:
6+
7+
1. **[Open an issue](https://github.com/github/opensource.guide/issues)** with your suggestion. Please explain:
8+
* Why the topic is broadly useful to open source contributors
9+
* Why it doesn't fit into an existing guide
10+
* 3-5 bullets of expected sub-topics
11+
2. We (likely @bkeepers or @nayafia) will label the issue ```new-guide``` and share feedback.
12+
13+
At this point, we may decide the topic doesn't warrant a new guide and close the issue, or we may recommend adding the information to an existing guide. That's okay! All suggestions are welcomed contributions, because they help us understand what our community is thinking.
14+
15+
## If we decide to move forward on a new guide, we will:
16+
17+
- [ ] Label your issue ```research```
18+
- [ ] Collect existing community resources (links, blog posts, projects) on your issue. Everybody is welcome to contribute.
19+
* What else has been written on this topic?
20+
* What projects do this well?
21+
* Who might be people with valuable experience that we should talk to?
22+
- [ ] Open a PR with an outline for the new guide. Anyone is welcome to give feedback until we reach general consensus.
23+
- [ ] Label your issue ```in progress```
24+
- [ ] Add the guide to our editorial schedule with estimated date for 1st draft completion
25+
- [ ] Request assets from Design for illustrations, Twitter cards, and anything else needed
26+
- [ ] Label your issue ```draft``` and update PR with the 1st draft. Anyone is welcome to give feedback.
27+
- [ ] Make final edits and add estimated date for completion
28+
- [ ] Release the new guide! 🎉

0 commit comments

Comments
 (0)