Skip to content
This repository was archived by the owner on Aug 27, 2022. It is now read-only.

Latest commit

 

History

History
36 lines (30 loc) · 1.53 KB

File metadata and controls

36 lines (30 loc) · 1.53 KB

Contributing to Stack Builders Tutorials

First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to Stack Builders Tutorials, which are hosted in the Stack Builders Organization on GitHub. These are mostly just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Contributing Guide

  1. Fork it
  2. Create your tutorial branch (git checkout -b my-new-tutorial)
  3. Add your tutorial changes following the tutorial guide
  4. Commit your changes (git commit -am 'Add some tutorial')
  5. Push to the branch (git push origin my-new-tutorial)
  6. Create a new Pull Request

Tutorial Creation Guide

  1. Create a new directory for your tutorial under tutorials/<language>/
  2. Inside tutorials/<language>/<your-tutorial-dir> create a directory named code and place your tutorial's code in there
  3. Add a tutorial.md file under tutorials/<language>/<your-tutorial-dir> with the steps required for accomplishing your tutorial. Use this tutorial as a guide.
  4. Add into tutorial.md file the following variables (or at least one):
twitter-profile: jpvillaisaza
github-profile: jpvillaisaza
  1. If you want to add a personalized open graph image to your tutorial add this into tutorial.md:
image: <language>/<your-tutorial-dir>/<your-image>.png