Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from github/docs
[WIP] Add documentation
- Loading branch information
Showing
9 changed files
with
584 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
- [ ] I followed the contributing guidelines: ***LINK*** | ||
|
||
**Please note: we will close your issue without comment if you do not check the boxes above and provide ALL requested information.** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
- [ ] I followed the contributing guidelines: ***LINK*** | ||
|
||
I am: | ||
- [ ] Suggesting edits to an existing Topic page | ||
- [ ] Curating a new Topic page | ||
|
||
***********EDITING AN EXISTING TOPIC PAGE************ | ||
|
||
I'm suggesting these edits to an existing topic: | ||
- [ ] Image (and my file is `*.png`, square, dimensions 288x288) | ||
- [ ] Content (and my changes are in `index.md`) | ||
|
||
Please explain why these changes are necessary: | ||
|
||
|
||
************CURATING A NEW TOPIC PAGE************ | ||
|
||
- [ ] 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]`) | ||
- [ ] My folder contains a `*.png` image (if applicable) and `index.md` | ||
- [ ] I've filled out all required fields in `index.md`, per the Style Guide: ***LINK*** | ||
|
||
Please explain why you think this Topic page should be curated: | ||
|
||
**Please note: we will close your PR without comment if you do not check the boxes above and provide ALL requested information.** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Contributing | ||
|
||
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. | ||
|
||
This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. | ||
|
||
There are a few ways you can contribute: improving an existing Topic page, or curating a new Topic page. | ||
|
||
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. | ||
|
||
## Improving an existing Topic page | ||
|
||
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). | ||
|
||
To improve an existing Topic page, please **open a pull request** with your proposed changes: | ||
|
||
* To update the image, replace the image inside the topic's folder | ||
* To update the content, edit the `index.md` inside the topic's folder | ||
|
||
The [pull request template](./.github/PULL_REQUEST_TEMPLATE.md) provides guidance on the information you need to include. | ||
|
||
**Please fill out the pull request template completely.** If you do not fill out the template, your PR will be closed. | ||
|
||
## Curating a new Topic page | ||
|
||
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: | ||
|
||
![topic page](https://user-images.githubusercontent.com/1840802/30932236-c9c397d2-a37b-11e7-94be-5c9847ea2d71.png) | ||
|
||
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. | ||
|
||
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. | ||
|
||
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. | ||
|
||
**Please fill out the pull request template completely.** If you do not fill out the template, your pull request will be closed. |
Oops, something went wrong.