Skip to content

Latest commit

 

History

History
38 lines (20 loc) · 3.13 KB

CONTRIBUTING.md

File metadata and controls

38 lines (20 loc) · 3.13 KB
Raw

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. 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 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.

Note: updates won't immediately appear once we've merged your PR. We pull in these changes regularly to GitHub.

Improving an existing topic page

If a topic page already exists, it will be listed in the topics directory. The topic name should match its URL, e.g. https://github.com/topics/rails corresponds to the rails folder.

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 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. The default layout on https://github.com/topics/foo looks like this:

topic page

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, 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.

Please note that all suggestions must adhere to GitHub's Community Guidelines and Terms of Service. Per our Terms of Service, you are responsible 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 and style guide 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.