Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (23 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

40 lines (23 loc) · 1.59 KB
Raw

CONTRIBUTING

Please contribute!

We love collaboration.

Found a Bug?

  • Submit an issue on our Issues page here.

Code contributions?

  • Fork this repo to your Github account.
  • Clone your version on your account down to your machine from your account, e.g,. git clone https://github.com/<yourgithubusername>/standartox.git.
  • Make sure to track upstream progress (i.e., on our version of standartox at andschar/standartox) by doing git remote add upstream https://github.com/andschar/standartox.git. Before making changes make sure to pull changes in from upstream by doing either git fetch upstream then merge later or git pull upstream to fetch and merge in one step
  • Make your changes (bonus points for making changes on a new branch).
  • Push up to your account.
  • Submit a pull request to home base at andschar/standartox.

Code guidelines

We do not have strong guideline for our contributions and are happy to help.

  1. Please follow this styleguide for your contributions.

We want to keep dependencies to a minimum:

  1. Please use the data.table for data wrangling.

  2. Please use the lightweight jsonlite package for handling JSON.

  3. Be nice to the resources! Use appropriate timeouts.

  4. Tests go into a separate tests branch and not in the master branch.

Questions?

Get in touch: andschar@protonmail.com

Thanks for contributing!