Skip to content
This repository has been archived by the owner on Dec 8, 2017. It is now read-only.

Latest commit

 

History

History
56 lines (39 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

56 lines (39 loc) · 1.35 KB

License

The 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.

Set Up

This set of web pages uses DOCter, a Jekyll template for quickly building out project pages and documentation.

To run locally

You will need to have Ruby 2.2.2 install, the bundler gem, and pandoc

gem install bundler

on mac osx, you can use homebrew to install pandoc

brew update
brew install pandoc

Fork and clone the repo:

git clone [email protected]:18F/govconnect.git
cd govconnect
bundle install

Run Jekyll:

jekyll serve --baseurl ''

Contributing

If you'd like to contribute to this project, please use the fork-and-pull model:

  1. Fork this repository to your personal account.
  2. Create a branch and make your changes.
  3. Test the changes locally/in your personal fork.
  4. Submit a pull request to open a discussion about your proposed changes.
  5. We'll talk about it and decide to merge or request additional changes.