Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

39 lines (26 loc) · 1.17 KB
Raw

Contributing

The team welcomes contributions! To make changes:

  • Fork the repo and make a branch
  • Write your code (ideally with tests) and make sure the CircleCI build passes
  • Open a PR

Local development

Prerequisites

  • Java 8
  • Python2 (On macOS: brew install python3)
  • Python3 (On macOS: brew install python)
  • pipenv (pip3 install pipenv)

We recommend the free VSCode editor to work on python projects and Intellij IDEA Community Edition for Java projects.

One-time setup for development

  1. Fork the repository

  2. Generate the IDE configuration: ./gradlew idea

  3. Open projects in Intellij: open *.ipr

  4. Generate integration test bindings: ./gradlew generate

  5. In conjure-python-verifier/python:

    $ PIPENV_VENV_IN_PROJECT=1 pipenv shell # create the virtual environment
$ pipenv install --dev # install all dependencies

Development tips

  • run ./gradlew checkstyleMain checkstyleTest locally to make sure your code conforms to the code-style.
  • Use tox in conjure-python-verifier/python to run all tests