Skip to content

Commit

Permalink
Incorporate feedback from Scott (readme+contributing)
Browse files Browse the repository at this point in the history
  • Loading branch information
amaier committed Jan 8, 2018
1 parent 8e41f7e commit 1a0dcbc
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 17 deletions.
4 changes: 2 additions & 2 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ Labels: Please label your issue in accordance with our label descriptions. See o

Reproduction steps: If your issue is a bug, please apply the `bug` label and provide step-by-step information so that we can reproduce it ourselves.

To dos: If your issue describes an enhancement, please apply the `enhancement` label and provide a list of steps we can take to meet the goal of your proposed enhancement.

Files: If possible, please upload any files (such as wireframes, screenshots, or error logs) that might help us better understand this issue.

Definition of done: Define what criteria would need to be met in order to consider the issue completed (for example, a list of steps we can take). If your issue describes an enhancement, please apply the `enhancement` label.
23 changes: 8 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,11 @@ In order to function well within cross-functional teams, designers need to know
### Specific to 18F, specific to the federal government

It’s important to note that the 18F Methods are designed to account for two things that may not otherwise concern a more generic collection of design methods. First, these methods directly reflect and support 18F’s human-centered work. (They are also continuously updated in a human-centered way — how meta!). Second, 18F Methods are designed to keep federal employees on the happy side of the law. This collection specifically includes helpful information on topics for which designers working in the federal government may need clarification, such as privacy and the Paperwork Reduction Act.

## Getting started

### Reading the Methods online

You’re presently looking at the Method’s GitHub (code) repository. Please [visit our homepage](https://methods.18f.gov) to read the Methods online.

### Printing the Methods

To print a copy of the Methods for offline use, simply visit the [Methods homepage](https://methods.18f.gov) and select `file → print…` from your web browser.

### Running the Methods website on your local machine

You will need [Ruby](https://www.ruby-lang.org) ( > version 2.1.5 ). You may consider using a Ruby version manager such as [rbenv](https://github.com/sstephenson/rbenv) or [rvm](https://rvm.io/) to help ensure that Ruby version upgrades don’t mean all your [gems](https://rubygems.org/) will need to be rebuilt.
Expand All @@ -30,7 +24,8 @@ $ brew update
$ brew install ruby
```

To serve 18F Methods locally, using `methods` as the name of your new repository, run each of the following steps:
To serve 18F Methods locally, using `methods` as the name of your new repository:
Run each of the following steps to get the site up and running.

```
git clone [email protected]:18F/methods
Expand All @@ -40,12 +35,8 @@ jekyll serve
```

You should be able to see the site at: `http://localhost:4000/`


## We follow the 18F style guide

The site uses a custom set of styles that inherit from the [U.S. Web Design Standards](https://standards.usa.gov/) and [18F brand](https://brand.18f.gov/) guidelines.

### Contributing to the Methods
For more information on contributing to the Methods (or even making a suggestion), see [CONTRIBUTING.md](contributing.md).
## Current team

- Product owner: Eric Ronne
Expand All @@ -54,19 +45,21 @@ The site uses a custom set of styles that inherit from the [U.S. Web Design Stan

## Past contributors

- Melissa Braxton
- Jeremy Canfield
- Erica Deahl
- Carolyn Dew
- James Hupp
- Nicky Krause
- Colin MacArthur
- Brad Nunnally
- Jennifer Thibault
- Russ Unger
- Victor Zapanta

## Public domain

This project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md):
> 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](https://creativecommons.org/publicdomain/zero/1.0/).
>
> 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.
> 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.

0 comments on commit 1a0dcbc

Please sign in to comment.