Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (50 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

64 lines (50 loc) · 3.12 KB

Contributing

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Git Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Git Flow). All pull requests get merged into the develop branch (active development branch), which when release gets merged to the master (production branch). We actively welcome your pull requests:

  1. Fork the repo and create your branch from develop.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Commit your changes. We follow an adapted version of @commitlint/config-conventional
    1. header-max-length: 72
    2. scope-enum: ['yargs', 'cli', 'deps', 'deps-dev']
  7. Issue that pull request!
git checkout develop
git checkout -b feature/some_branch # OR git flow feature start some_branch
pip install -r requirements.txt # Install yamllint
npm install # Install dependencies.
#
#.... modify the code ....
#
npm run test  # Ensure the test suite passes.
npm run lint  # Make sure your code lints.
npm run commit  # Follow @commitlint/config-conventional. Refer [.commitlintrc.js](https://github.com/libinvarghese/recursive-copy-cli/blob/master/.commitlintrc.js)
git push feature/some_branch # OR git flow feature publish

Any contributions you make will be under the ISC Software License

In short, when you submit code changes, your submissions are understood to be under the same ISC License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports.

Use a Consistent Coding Style

This document was adapted from the open-source contribution guidelines for Facebook's Draft

  • 2 spaces for indentation rather than tabs
  • You can try running npm run lint for style unification