Contributing Guide

• Contributing to cleandocs is fairly easy. This document shows you how to get started

General

• The Code Base structure:
  • public /
    • asstes /
    • js /
    • svgs /
  • index.html /
  • docs.html /

Submitting changes

• Fork the repo
  • https://github.com/lmas3009/cleandocs-template
• Check out a new branch based and name it to what you intend to do:
  • Example:

    $ git checkout -b BRANCH_NAME
    

    If you get an error, you may need to fetch fooBar first by using

    $ git remote update && git fetch
    

  • Use one branch per fix / feature
• Commit your changes
  • Please provide a git message that explains what you've done
  • Please make sure your commits follow the conventions
  • Commit to the forked repository
  • Example:

    $ git commit -am 'Add some fooBar'
    

• Push to the branch
  • Example:

    $ git push origin BRANCH_NAME
    

• Make a pull request
  • Make sure you send the PR to the master branch

If you follow these instructions, your PR will land pretty safely in the main repo!