Light Mode

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 987a8cd

Browse files
committed
Revised docs per @cheshire137 and @talsafran review
1 parent 24357f3 commit 987a8cd

File tree

2 files changed

+20
-10
lines changed
  • .github
    • PULL_REQUEST_TEMPLATE.md
  • CONTRIBUTING.md

2 files changed

+20
-10
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,29 @@ I am:
66

77
***********EDITING AN EXISTING TOPIC OR COLLECTION************
88

9-
I'm suggesting these edits to an existing topic:
9+
I'm suggesting these edits to an existing topic or collection:
1010
- [ ] Image (and my file is `*.png`, square, dimensions 288x288)
1111
- [ ] Content (and my changes are in `index.md`)
1212

1313
Please explain why these changes are necessary:
1414

1515

16-
************CURATING A NEW TOPIC OR COLLECTION************
16+
************CURATING A NEW TOPIC************
1717

1818
- [ ] I've formatted my changes as a new folder directory, named for the topic as it appears in the URL on GitHub (e.g. `https://github.com/topics/[NAME]`)
1919
- [ ] My folder contains a `*.png` image (if applicable) and `index.md`
2020
- [ ] All required fields in my `index.md` conform to the Style Guide and API docs: https://github.com/github/explore/tree/master/docs
2121

22-
Please explain why you think this topic or collection should be curated:
22+
Please explain why you think this topic should be curated:
23+
24+
25+
************CURATING A NEW COLLECTION************
26+
27+
- [ ] I've formatted my changes as a new folder directory, named for the collection as it appears in the URL on GitHub (e.g. `https://github.com/collections/[NAME]`)
28+
- [ ] My folder contains a `*.png` image (if applicable) and `index.md`
29+
- [ ] All required fields in my `index.md` conform to the Style Guide and API docs: https://github.com/github/explore/tree/master/docs
30+
31+
Please explain why you think this collection should be curated:
32+
2333

2434
**Please note: we will close your PR without comment if you do not check the boxes above and provide ALL requested information.**

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22

3-
Hi there! We're excited you've got ideas to improve topics and collections. Your helping the community discover valuable information.
3+
Hi there! We're excited you've got ideas to improve topics and collections. You're helping the community discover valuable information.
44

55
This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
66

@@ -17,20 +17,20 @@ Note: Updates won't immediately appear once we've merged your PR. We pull in the
1717

1818
If a topic or collection already exists, it will be listed in its respective directory:
1919

20-
- [Topics](https://github.com/github/explore/tree/master/topics)
21-
- [Collections](https://github.com/github/explore/tree/master/collections)
20+
- [topics/](https://github.com/github/explore/tree/master/topics)
21+
- [collections/](https://github.com/github/explore/tree/master/collections)
2222

2323
The topic or collection name should match its URL, e.g. `https://github.com/topics/rails` corresponds to the [`topics/rails` directory](https://github.com/github/explore/tree/master/topics/rails).
2424

2525
To make an improvement, please **open a pull request** with your proposed changes:
2626

2727
### Update the image
2828

29-
To update the image, simply replace the image inside the topic or collection's directory
29+
To update the image, simply replace the image inside the topic or collection's directory.
3030

31-
### Update text & links
31+
### Update text and links
3232

33-
To update text and links, edit the `index.md` inside the topic or collection's directory. These files are formatted using a combination of [front matter](https://jekyllrb.com/docs/frontmatter/) and simple body content.
33+
To update text and links, edit the `index.md` inside the topic or collection's directory. These files are formatted using a combination of [Front Matter](https://jekyllrb.com/docs/frontmatter/) and simple body content.
3434

3535
For **topics**, you'll notice that, in examples like "[algolia](https://raw.githubusercontent.com/github/explore/master/topics/algolia/index.md)," data like the topic's canonical URL, Wikipedia URL, or display name are called out in key-value pairs; while its detailed description is accounted for in the body of the document.
3636

@@ -81,7 +81,7 @@ We are likely to consider suggestions to curate a topic or collection that is va
8181

8282
Please note that all suggestions must adhere to GitHub's [Community Guidelines](https://help.github.com/articles/github-community-guidelines/) and [Terms of Service](https://help.github.com/articles/github-terms-of-service/). Per our Terms of Service, [you are responsible](https://help.github.com/articles/github-terms-of-service/#d-user-generated-content) for the content you contribute, and you must have the rights to use it.
8383

84-
To propose a new topic or collection, please **open an pull request** with your proposed additions. The [API docs](./docs/API.md) and [style guide](./docs/styleguide.md) provide guidance on the information you need to include and how it should be formatted.
84+
To propose a new topic or collection, please **open a pull request** with your proposed additions. The [API docs](./docs/API.md) and [style guide](./docs/styleguide.md) provide guidance on the information you need to include and how it should be formatted.
8585

8686
This repository includes [a list of the most-used GitHub topics that don't yet have extra context](topics-todo.md). If your pull request adds one of these topics, please update topics-todo.md so that the topic is checked (marked complete).
8787

0 commit comments

Comments
(0)