Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

44 lines (28 loc) · 1.77 KB
Raw

Contributing to this wiki

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to this repository. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

  1. Code of Conduct
  2. Styleguides

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to aaronlichtman@gmail.com.

Styleguides

Content

  • All content in this wiki must be both correct and explained in an easily understood manner.
  • Feel free to include any images that have high educational value.

Issues

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a comprehensive description of the suggested enhancement in as much detail as possible.
  • (If applicable) Provide specific examples to demonstrate the steps. Include code snippets which you use in those examples, as Markdown code blocks.

Commit Messages

  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Pull Requests

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Include any relevant issue numbers in the PR body, not the title.
  • Provide a comprehensive description of all changes made.
  • End all files with a newline