Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Development Environment Setup #4

Merged
merged 1 commit into from
Nov 10, 2017
Merged

Development Environment Setup #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Contributor's Guide

This guide contains information to help you contribute to this project.

## Development Environment

This section contains information to help you set up a local Mac OS development environment.

### Installing

Before you begin, make sure you have installed these requirements:

+ Ruby (version 2.4.0)
+ Bundler (version 1.16.0)
+ Git

Then install the source code and package dependencies:

```shell
git clone [email protected]:XDgov/data-design-standards.git
cd data-design-standards/
bundle install
```

### Usage

To view the project in a local web browser:

```shell
bundle exec jekyll serve # then visit localhost:4000
```