Skip to content
This repository has been archived by the owner on Sep 16, 2021. It is now read-only.

Contributing to the examples

Jonathan Bell edited this page Feb 23, 2018 · 1 revision

Editing an in-practice example

  1. Visit the _in-practice-examples folder.
  2. Click the example that you would like to edit, then select the pencil icon (top-right)
  3. The repository will be automatically forked to your repository and you will be able to edit the file.
  4. When you are finished making all of your edits to the file, click the green "commit" button at the bottom of the page. There will be a place to provide a description of your change; this is to describe to the site steward, the nature of the change, and helps expedite the process.
  5. Now, on your forked repository's homepage, click "Pull Request".
  6. Follow the instructions giving reasons for your changes, then click submit in order to submit your request.

Adding a new in-practice example

  1. Fork the Toolkit by clicking the "Fork" button in the top right of the page.
  2. Now, on your forked copy of the repository, visit the _in-practice-examples folder.
  3. Click "Add new file" and name your file by the new practice name in all lowercase letters and/or numbers, replacing any spaces with a hyphen (-) followed by .md Example: new-practice.md
  4. Create your new practice, adding its content to the body of the new markdown file. Save the file, by clicking the green button.
  5. Now, on your forked repository's homepage, click "Pull Request".
  6. Follow the instructions giving reasons for your changes, then click submit in order to submit your request.