-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
37bdf57
commit 2d1adb5
Showing
1 changed file
with
41 additions
and
0 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,41 @@ | ||
--- | ||
layout: | ||
title: | ||
visible: true | ||
description: | ||
visible: true | ||
tableOfContents: | ||
visible: true | ||
outline: | ||
visible: false | ||
pagination: | ||
visible: false | ||
--- | ||
|
||
# How to contribute | ||
|
||
## Create Issues | ||
|
||
If you have identified an issue in the documentation, have a suggestion for additional content or are seeking an improvement that could be made please do so by raising an issue: | ||
|
||
1. Navigate to the main page of the GitHub repository. | ||
2. Click the "Issues" button. | ||
3. Click "New Issue". | ||
4. Provide an informative "Title". | ||
5. Provide a description of your issue / suggestion / improvement in the comment body field. | ||
6. When you are finished click "Submit new issue". | ||
|
||
## Pull Requests | ||
|
||
If you would like to propose changes to the documentation, you can submit a pull request: | ||
|
||
Here’s how it generally works: | ||
|
||
1. Fork the project. | ||
2. Create a topic branch from `master`. | ||
3. Make some commits to improve the project. | ||
4. Push this branch to your GitHub project. | ||
5. Open a Pull Request on GitHub. | ||
6. Discuss, and optionally continue committing. | ||
7. The project owner merges or closes the Pull Request. | ||
8. Sync the updated `master` back to your fork. |