Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 2.34 KB

README.md

File metadata and controls

45 lines (32 loc) · 2.34 KB

Project Template

  • TODO: Search this document for ALL TODOs, there are some buried in the Markdown links so be thorough, when you complete a TODO delete it from the README.
  • TODO: Assign at least one person to own and lead the project, they are responsible for ensuring success. It is up to them how to manage and organize tasks for the project.
  • TODO: Write a detailed description of the project here.
  • TODO: Add description of project to projects section of website.
  • TODO: Create a slack channel for the project.

Getting Started

  • TODO: Technical documentation to clone, install and run the project goes here.

Contributing

We welcome new contributors. Be sure to check out guide on contributing, which includes instructions on how to fork, clone, branch, commit, pull request and sync your fork.

Not sure where to start? Look for open issues on GitHub, or message the team on our Slack site. If you aren't on our Slack, click here for an invite.

TL;DR Contribution Workflow:

  1. Fork this repository and Clone your fork locally.
  2. Checkout a new branch on which to make your changes.
  3. Make edits. Try to match existing coding style.
  4. Test your changes.
  5. Commit your changes. Push your changes to your fork on GitHub.
  6. Submit a new pull request and your changes will be reviewed and merged.

Bugs / Feedback / Suggestions / Questions

We encourage you to open up an issue if you have any feedback, suggestions, bugs or just have a question on where to start.

License

MIT, see LICENSE for full license.