Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

37 lines (25 loc) · 1.08 KB
Raw

Contribution guidelines

Before sending a Pull Request, please make sure that you're assigned the task on a GitHub issue.

  • If a relevant issue already exists, discuss on the issue and get it assigned to yourself on GitHub.
  • If no relevant issue exists, open a new issue and get it assigned to yourself on GitHub.

Please proceed with a Pull Request only after you're assigned. It'd be bad time if your Pull Request and your hardwork isn't accepted just because it isn't ideologically compatible.

Developing the Project

  1. Install with

    git clone https://github.com/iamjohnnym/auto-pyvenv
cd auto-pyvenv
make build

  2. Make your changes in a different git branch (eg, enhancement/new-feature). These changes can be

    • enhancing the service
    • fixing a bug
    • adding additional tests

  3. (Optional) To test whether auto-pyvenv was built successfully.

    make test

  4. (Required for all changes) Ensure linting is valid

    make flake

  5. (Required for new steps) Add command to both .travis.yml file and Makefile.