Skip to content
This repository has been archived by the owner on Jan 25, 2023. It is now read-only.

Latest commit

 

History

History
97 lines (63 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

97 lines (63 loc) · 3.3 KB
Raw

Contributing Guide

Syphon is a part-time effort from a small team, so contributions are welcome! This document shows you how to get the project, run all provided tests, and generate a production-ready build.

Dependencies

To make sure that the following instructions work, install the following dependencies on your machine:

  • Python 3.6
  • Git

Installation

To retrieve the Syphon source code, clone the git repository with:

$ git clone https://github.com/tektronix/syphon

This will clone the complete source to your local machine. Navigate to the project folder and install all dependencies:

$ pip install -e .[dev,test]

This this will install everything required to package and test the project.

Testing

Syphon uses tox for its environment management, pytest for its testing framework, and pytest-cov to calculate test coverage.

Source Linting: pylint --rcfile=.pylintrc syphon

Performs linting on all source files.

Unit Testing: tox [-- --slow]

Executes quick tests (or all tests) against all supported Python environments. Code coverage is automatically calculated after all tests are performed.

Testing be performed against a specific environment with

$ tox -e ENV [-- --slow]

where ENV is a supported environment, a list of which can be viewed by running

$ tox --listenvs

Unit test files are located in syphon/tests. To run a single test file, you should call pytest directly:

$ pytest syphon/test/test_something.py

Contributing/Submitting Changes

  • Create a fork from the latest canary branch and name it what you intend to do.
    • Branch names should start with:
      • topic/
      • feature/
      • bugfix/
    • Use one branch per feature/bugfix.
    • Words in the branch name should be hyphen (-) delimited.
    • Example: 
      $ git remote update && git fetch
$ git checkout -b topic/speed-improvements origin/canary
  • Make your changes.
    • Add or edit unit tests as appropriate.
    • Run tox.
      • Ensure no linting errors are present.
      • All unit tests must pass.
      • Coverage should be the same or better than when you started.
  • Commit your changes.
    • Each commit should be as limited in scope as possible.
    • Ensure your commit messages are concise.
  • Submit a pull request.
    • Make sure your PR is against the canary branch.

Your pull request will serve as a code review. All submissions, including those by project members, require review.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.