Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

41 lines (32 loc) · 1.29 KB

Contributing

Contributions, questions, and comments pull requests are all welcome. If you want to change the structure, please open an issue to start a discussion. However, if you have interesting questions or answers, please make a pull request.

Getting Started

  • Make sure you have a GitHub account
  • Submit a Github issue for this Repo
  • Clearly describe the issue
  • Fork the repository on GitHub

Making Changes

  • Fork repo
  • Create a branch (git checkout -b fix/my_awesome_change)
  • Make commits of logical and atomic units
  • Check for unnecessary whitespace with git diff --check before committing
  • Make sure your commit messages are in the proper format:
    • Short (less than 70)
    • Start the line with "Fix", "Add", "Change" instead of "Fixed", "Added", "Changed"
    • Capitalize the subject line
  • Push changes
  • Create Pull Request to master

Available link tags

To make links short and self-descriptive use special tags:

  • @blog - blog
  • @docs - webpage
  • @youtube
  • @docs - documentation format
  • @code - live code examples
  • @stackoverflow - link to answer/discussion on stackoverflow.com
  • @github - link some repo on github.com
  • @wiki - link to wikipedia.org

Thanks to all these cool people ✋:
Ken Hawkins