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.
Requires Docker.
- Run
cp config.example.json config.json. - Modify
config.json.
- See the instructions for getting your AWS credentials.
- Exclude the
s3://prefix/protocol forbucket.
- Run
./test/out </full/path/to/dir>. - Run
./test/in </full/path/to/dir>. - Run
./test/check.
Every tag and branch created on this repository is automatically built on Docker Hub.
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.