Skip to content
This repository was archived by the owner on May 24, 2018. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
88 lines (58 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

88 lines (58 loc) · 1.72 KB

Contributing

First of all, thanks for taking the time to submit a pull request!

These are the few notes and guidelines to keep things coherent.

Overview

  1. Fork the project and clone.
  2. Check you have all requirements in place.
  3. Create your feature branch.
  4. Install the project dependencies for development.
  5. Test.
  6. Push your branch and submit a Pull Request.
  7. Add a description of your proposed changes and why they are needed.

We will review the changes as soon as possible.

Requirements

  • Fork the project and clone.
  • Python (tested with version 2.7).
  • pip.
  • OSX if you want to use the proxyswitch.
  • xcode-select --install if you use OSX.

Note: You can use Docker to develop and test Mastermind. It is actually the main way it has been developed at ustwo.

Install

To install just dependencies:

$ make install
$ ./mastermind.py --version

To install it in the system from your git clone:

$ make system-install
$ mastermind --version

To build a new Docker image:

$ make docker-build

Feature Branch

git checkout -b features/feature-name

Test

To run tests on a simple install:

$ make raw-test

To run tests on a fresh Docker build:

$ make test

To run tests on Docker with you current working directory mounted in:

$ make local-test

Artifacts

If you need to create artifacts for a release or just testing:

$ make bundle-mastermind
$ make bundle-proxyswitch