Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 1.94 KB

Welcome!

We're so glad you're thinking about contributing to an 18F open source project! If you're unsure about anything, just ask -- or submit the issue or pull request anyway. The worst that can happen is you'll be politely asked to change something. We love all friendly contributions.

We want to ensure a welcoming environment for all of our projects. Our staff follow the 18F Code of Conduct and all contributors should do the same.

We encourage you to read this project's CONTRIBUTING policy (you are here), its LICENSE, and its README.

If you have any questions or want to read more, check out the 18F Open Source Policy GitHub repository, or just shoot us an email.

Public domain

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

Validating the data

To check that the schema is valid, run:

  1. Clone (or update) the schemas repository into this one.

    git clone https://github.com/opencontrol/schemas.git
    # or
    cd schemas && git pull origin master && cd ..
  2. Install the dependencies.

    pip install -r requirements.txt
  3. Run the tests.

    py.test

Viewing as a GitBook

make serve

BDD tests

This repository also contains setup and run instructions for a set of BDD tests that help verify Cloud Foundry control implementations.