|
1 | 1 | # Contributing |
2 | 2 |
|
3 | | -Hi there! We're excited you've got ideas for an existing or new topic page. Your help makes Explore valuable to others in your community. |
| 3 | +Hi there! We're excited you've got ideas to improve topics and collections. Your helping the community discover valuable information. |
4 | 4 |
|
5 | 5 | This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. |
6 | 6 |
|
7 | | -There are a few ways you can contribute: improving an existing topic page, or curating a new topic page. |
| 7 | +There are a few ways you can contribute: |
| 8 | + |
| 9 | +- Improving an existing topic or collection |
| 10 | +- Curating a new topic topic or collection |
8 | 11 |
|
9 | 12 | As you write content, check out the [Style Guide](./docs/styleguide.md) to learn what each field means, and how they should be formatted. Following the style guide will improve the chances of your contribution being accepted. |
10 | 13 |
|
11 | | -Note: updates won't immediately appear once we've merged your PR. We pull in these changes regularly to GitHub. |
| 14 | +Note: Updates won't immediately appear once we've merged your PR. We pull in these changes regularly to GitHub. |
12 | 15 |
|
13 | | -## Improving an existing topic page |
| 16 | +## Improving an existing topic or collection |
14 | 17 |
|
15 | | -If a topic page already exists, it will be listed in the [topics directory](https://github.com/github/explore/tree/master/topics). The topic name should match its URL, e.g. `https://github.com/topics/rails` corresponds to the [`rails` folder](https://github.com/github/explore/tree/master/topics/rails). |
| 18 | +If a topic or collection already exists, it will be listed in its respective directory: |
16 | 19 |
|
17 | | -To improve an existing topic page, please **open a pull request** with your proposed changes: |
| 20 | +- [Topics](https://github.com/github/explore/tree/master/topics) |
| 21 | +- [Collections](https://github.com/github/explore/tree/master/collections) |
18 | 22 |
|
19 | | -* To update the image, replace the image inside the topic's folder |
20 | | -* To update the content, edit the `index.md` inside the topic's folder |
| 23 | +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). |
21 | 24 |
|
22 | | -The [pull request template](./.github/PULL_REQUEST_TEMPLATE.md) provides guidance on the information you need to include. |
| 25 | +To make an improvement, please **open a pull request** with your proposed changes: |
23 | 26 |
|
24 | | -**Please fill out the pull request template completely.** If you do not fill out the template, your PR will be closed. |
| 27 | +### Update the image |
| 28 | + |
| 29 | +To update the image, simply replace the image inside the topic or collection's directory |
| 30 | + |
| 31 | +### Update text & links |
| 32 | + |
| 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. |
| 34 | + |
| 35 | +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. |
| 36 | + |
| 37 | +_/topics/algolia/index.md_: |
| 38 | +``` |
| 39 | +--- |
| 40 | +aliases: algoliasearch, algolia-search |
| 41 | +related: instantsearch, instant-search |
| 42 | +created_by: Nicolas Dessaigne, Julien Lemoine |
| 43 | +display_name: Algolia |
| 44 | +github_url: https://github.com/algolia/ |
| 45 | +logo: algolia.png |
| 46 | +released: October 23, 2012 |
| 47 | +short_description: Algolia is a hosted search API for web and mobile applications. |
| 48 | +topic: algolia |
| 49 | +url: https://www.algolia.com/ |
| 50 | +wikipedia_url: https://en.wikipedia.org/wiki/Algolia |
| 51 | +--- |
| 52 | +Algolia is a hosted API for building search into web and mobile applications, with typo-tolerance, fully configurable relevance, and other tools for making great search experiences. |
| 53 | +``` |
25 | 54 |
|
26 | | -## Curating a new topic page |
| 55 | +--- |
| 56 | + |
| 57 | +Similarly, **collections** like "[music](https://raw.githubusercontent.com/github/explore/master/collections/music/index.md)" call out things like their author and display name in key-value pairs -- with a detailed description in the body of the document. Most importantly, though, collections identify their individual collection items in a comma-separated string value for the key "items." |
| 58 | + |
| 59 | +_/collections/music/index.md_: |
| 60 | + |
| 61 | +``` |
| 62 | +--- |
| 63 | +items: beetbox/beets, scottschiller/SoundManager2, CreateJS/SoundJS, musescore/MuseScore, tomahawk-player/tomahawk, cashmusic/platform, mopidy/mopidy, AudioKit/AudioKit, Soundnode/soundnode-app, gillesdemey/Cumulus, metabrainz/picard, overtone/overtone, samaaron/sonic-pi |
| 64 | +display_name: Music |
| 65 | +created_by: jonrohan |
| 66 | +--- |
| 67 | +Drop the code bass with these musically themed repositories. |
| 68 | +``` |
| 69 | + |
| 70 | +--- |
| 71 | + |
| 72 | +The [pull request template](./.github/PULL_REQUEST_TEMPLATE.md) also provides guidance on the information you need to include. |
| 73 | + |
| 74 | +**Please fill out the pull request template completely.** If you do not fill out the template, your PR will be closed. |
27 | 75 |
|
28 | | -If a topic page is not yet curated, it will NOT be listed in the [topics directory](https://github.com/github/explore/tree/master/topics). The default layout on `https://github.com/topics/foo` looks like this: |
| 76 | +## Curating a new topic or collection |
29 | 77 |
|
30 | | - |
| 78 | +If a topic or collection is not yet curated, it will NOT be listed in its respective directory. |
31 | 79 |
|
32 | | -We are likely to consider suggestions to curate a topic page that is valuable to GitHub's community. Valuable topics include those that are already [widely used by repositories](https://help.github.com/articles/classifying-your-repository-with-topics/), or a topic that currently lacks important information. When suggesting content for a topic page, please consider how to make your contribution broadly useful and relevant to others, rather than serving a specific use case. |
| 80 | +We are likely to consider suggestions to curate a topic or collection that is valuable to GitHub's community. Valuable topics, for example, include those that are already [widely used by repositories](https://help.github.com/articles/classifying-your-repository-with-topics/), or a topic that currently lacks important information. When suggesting content, please consider how to make your contribution broadly useful and relevant to others, rather than serving a specific use case. |
33 | 81 |
|
34 | 82 | 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. |
35 | 83 |
|
36 | | -To propose a new topic page, please **open an pull request** with your proposed changes. 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 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. |
37 | 85 |
|
38 | 86 | 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). |
39 | 87 |
|
|
0 commit comments