Skip to content

Latest commit

 

History

History
125 lines (85 loc) · 5.24 KB

CONTRIBUTING.md

File metadata and controls

125 lines (85 loc) · 5.24 KB
Raw

Contributing to Popper

Thank you for your interest in contributing to Popper 🎉!

This document is a part of a set of guidelines for contributing to Popper on GitHub. These are guidelines, not rules. This guide is meant to make it easy for you to get involved.

Our goal is to make it easier for programmers to use DevOps tools and follow software engineering best-practices when they implement experimentation pipelines. Our goal is to lower the barriers for collaboration and the sharing of knowledge.

Participation guidelines

Popper adheres to our code of conduct, posted in this repository. By participating or contributing to Popper, you're expected to uphold this code. If you encounter unacceptable behavior, please immediately email us.

What to work on

Take a look at the list of projects to get started. We also welcome any new ideas! In addition, a list of specific issues tagged with good first issue.

Keywords in Issue Titles

The title of each open issue is prefixed with a keyword that denotes the following:

  • cli. An issue that involves modifying code of the CLI tool.

  • doc. An issue that involves modifying the documentation.

  • example. An issue that involves the creation of an example Workflow that showcases available features of the CLI tool, as well as the catalog of pre-defined actions.

  • q. A question regarding the use of the tool.

Branches

There are two main branches of the codebase:

  • v1.x. This branch tracks the older version of the CLI tool which supported workflows being defined in YAML format. This is documented here.
  • master. This tracks the latest 2.x series, which adopted Github actions workflows as the main supported format.

Development Environment Setup

See the Development Setup section.

Running tests

To run tests on your machine:

cd popper/

# activate the virtualenv
source $HOME/venvs/popper/bin/activate

# run all tests
python -X tracemalloc -m unittest -f src/test/test_*

# run only one
python -X tracemalloc -m unittest -f src/test/test_runner.py

Codestyle

Popper's code is formatted using the black style. If code does not conform to this style, merges are prevented to the master and this is checked as a CI step.

To apply black to your code, run black from the root Popper directory:

cd popper
black .

How to contribute changes

Once you've identified one of the issues above that you want to contribute to, you're ready to make a change to the project repository!

  1. Fork this repository. This makes your own version of this project you can edit and use.
  2. Make your changes! You can do this in the GitHub interface on your own local machine. Once you're happy with your changes...
  3. Submit a pull request. This opens a discussion around your project and lets the project lead know you are proposing changes.

First time contributing to an open source project? Check out this guide on how to contribute to an open source project on GitHub.

How to report bugs

We track bugs as GitHub issues. Before posting a bug as a new issue, please do a search to see if the bug you're experiencing was already reported by someone else. If it was, add a comment to that issue instead of creating a new one.

How to submit good bug reports

A more detailed bug report will help people track down and fix your issue faster. Try to include the following in your bug report if you can:

  • Create a detailed title in your report to properly explain your issue
  • Include any screen captures or terminal output if necessary.
  • List what version of Popper you are using.
  • Describe an exact sequence of steps that can reproduce your issue. If you can't reliably replicate your issues, explain what you were doing before the problem happened and how often it happens.
  • Is this a new bug? Include when you started having these issues.

Post any bugs, requests, or questions on the GitHub issues page for Popper!

Communication channels

If want to contribute and you're still not certain on how to start please feel free to email us, chat on Gitter or open an issue.