Skip to content

Commit

Permalink
contrib: Updated to add video tutorials
Browse files Browse the repository at this point in the history
also Fixes 96boards#425

Signed-off-by: Sahaj Sarup <[email protected]>
  • Loading branch information
ric96 committed May 4, 2018
1 parent 68151e9 commit 3daddfc
Showing 1 changed file with 26 additions and 7 deletions.
33 changes: 26 additions & 7 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,30 @@ Thanks for stopping by to contribute the mezzanine-community repository! The fol

## Bugs and Suggestions

Before attempting to fix the issue/bug on your own, it is recommended to open an issue using the [built-in issues page](https://github.com/96boards/documentation/issues) provided in this GitHub repository. One of our maintainers will get around to your issue as soon as possible. After review, the maintainer may fix the issue on his/her own, or request the subject step in to fix the observed issue. If inclined, at this point you should fork the repository, make said edits, and submit a [Pull Request](https://help.github.com/articles/about-pull-requests/).
Before attempting to fix the issue/bug on your own, it is recommended to open an issue. There are two ways of doing that:
- Using "Report an Issue" button integrated on every page of our website placed on the bottom right.

- More information on [GitHub issues](https://guides.github.com/features/issues/).
- More information on submitting a [Pull Request](https://help.github.com/articles/about-pull-requests/)
![Report an Issue](https://i.imgur.com/qM1bJjH.png)
- Using the [built-in issues page](https://github.com/96boards/documentation/issues) provided in this GitHub repository.

One of our maintainers will get around to your issue as soon as possible. After review, the maintainer may fix the issue on his/her own, or request the subject step in to fix the observed issue. If inclined:
- Send your edits using "Edit on GitHub" button integrated on every page of our website placed on the bottom right.

![Report an Issue](https://i.imgur.com/qM1bJjH.png)
- Or manually fork the repository, make said edits, and submit a [Pull Request](https://help.github.com/articles/about-pull-requests/).

Please make sure you comply with the following criteria when creating/submitting your issue:

- **Use a clear and descriptive title** for the issue to identify the problem/suggestion.
- **Describe the exact steps to reproduce the problem** in as many details as possible in the case of a problem or suggestion
- **Mention location** where was this issue is found / what will your suggestion affect.

If You need help with submitting an issue or a pull request on GitHub, take a look at our tutorial over at YouTube:
- [Submit an issue](https://www.youtube.com/watch?v=OzitElQoHzU&index=1&list=PL-NF6S9MM_W1Lf714oYsSRIHT4bL_8P7e)
- [Fork the Repository](https://www.youtube.com/watch?v=PXgqMPSMG-o&index=0&list=PL-NF6S9MM_W1Lf714oYsSRIHT4bL_8P7e)
- [Send a Pull Request](https://www.youtube.com/watch?v=k4VtYyjakOw&index=3&list=PL-NF6S9MM_W1Lf714oYsSRIHT4bL_8P7e)
- More information on [GitHub issues](https://guides.github.com/features/issues/).
- More information on submitting a [Pull Request](https://help.github.com/articles/about-pull-requests/)
***

## Contribution
Expand All @@ -40,12 +53,17 @@ Please make sure you comply with the following criteria when creating/submitting
Community contributions are always Welcome! This section is intended to help anyone interested in contributing to this repository. For quick fixes and corrections its fine just to get stuck in. On the other hand if you want to add new pages then, before you spend a long time working on it, it is a good idea to discuss your idea with the repository maintainers and community by raising a [GitHub issue](https://github.com/96boards/documentation/issues) using the guidelines mentioned above.

Either way, when you are ready to make changes, you will need to do the following (these instructions assume you are a [GitHub user](https://github.com/join):
- ###### Step 1: [Fork this repository](https://help.github.com/articles/fork-a-repo/)
- Send your changes using "Edit on GitHub" button integrated on every page of our website placed on the bottom right.

- ###### Step 2: [Make changes, commit and push to your fork](https://services.github.com/on-demand/github-cli/add-commits-git)
![Report an Issue](https://i.imgur.com/qM1bJjH.png)

- ###### Step 3: [Submit Pull Request](https://help.github.com/articles/creating-a-pull-request/)
- When submitting a Pull Request to the 96Boards repository, there's a check list in the [Guidelines for submitting a Pull Request](#guidelines-for-submitting-a-pull-request) section to help you.
- Manually send them using git:
- ###### Step 1: [Fork this repository](https://help.github.com/articles/fork-a-repo/)
- [Video Tutorial on How to Fork the Repository](https://www.youtube.com/watch?v=PXgqMPSMG-o&index=0&list=PL-NF6S9MM_W1Lf714oYsSRIHT4bL_8P7e)
- ###### Step 2: [Make changes, commit and push to your fork](https://services.github.com/on-demand/github-cli/add-commits-git)
- ###### Step 3: [Submit Pull Request](https://help.github.com/articles/creating-a-pull-request/)
- [Video Tutorial on How to Send a Pull Request](https://www.youtube.com/watch?v=k4VtYyjakOw&index=3&list=PL-NF6S9MM_W1Lf714oYsSRIHT4bL_8P7e)
- When submitting a Pull Request to the 96Boards repository, there's a check list in the [Guidelines for submitting a Pull Request](#guidelines-for-submitting-a-pull-request) section to help you.

A full fledged git and github training is available here: [GitHub On Demand Training](https://services.github.com/on-demand/)

Expand Down Expand Up @@ -120,6 +138,7 @@ If you have recently launched a new 96Boards and have to add it to the documenta
- Make sure to place all the images in the ```assets/images``` folder with the correct resolution as mentioned in the template.
- If your board has its guides section populated, make sure to add the board to our [guides page](guides) ```/guides/README.md```
- Before submitting a Pull Request to the 96Boards repository, make sure to read and adhere to our guidelines mentioned in the [Guidelines for submitting a Pull Request](#guidelines-for-submitting-a-pull-request) section.
- Also take a look at our [Contribution Guide](https://www.youtube.com/playlist?list=PL-NF6S9MM_W1Lf714oYsSRIHT4bL_8P7e) play-list over at YouTube for short tutorials.
***
Expand Down

0 comments on commit 3daddfc

Please sign in to comment.