Skip to content

Latest commit

 

History

History
26 lines (18 loc) · 1.65 KB

contributing.md

File metadata and controls

26 lines (18 loc) · 1.65 KB

Contributing

We welcome contributions and suggestions to help us improve this project. Please start by reading our contribution guidelines.

Workflow:

  1. Fork this repo
  2. Create a branch (git checkout -b my-branch)
  3. Stage and commit your changes (git commit -am 'description of my changes')
  4. Push the changes to your fork (git push origin my-branch)
  5. Submit a pull request to the parent repo. Please read our guide to submitting pull requests to see what we expect in a good pull request message.
  6. Pull requests should be assigned to:
    • @benlk (primary)
    • @INN/tech-team (secondary)

We have a helpful how-to that walks through this process in more detail if you're new to using Git, and the GitHub docs are quite useful.

Additionally, you can create issues on this repo to suggest changes or improvements.

And of course you can always email us: [email protected].

Standards

  • Follow all standards from the INN Nerds coding style guide.
  • Use markdown syntax for all text documents.
  • Pull requests for new functionality should be accompanied by tests wherever possible.