Skip to content
This repository was archived by the owner on May 31, 2024. It is now read-only.

Commit 1a0dcbc

Browse files
author
amaier
committed
Incorporate feedback from Scott (readme+contributing)
1 parent 8e41f7e commit 1a0dcbc

File tree

2 files changed

+10
-17
lines changed

2 files changed

+10
-17
lines changed

ISSUE_TEMPLATE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ Labels: Please label your issue in accordance with our label descriptions. See o
44

55
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.
66

7-
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.
8-
97
Files: If possible, please upload any files (such as wireframes, screenshots, or error logs) that might help us better understand this issue.
8+
9+
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.

README.md

+8-15
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,11 @@ In order to function well within cross-functional teams, designers need to know
77
### Specific to 18F, specific to the federal government
88

99
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.
10-
1110
## Getting started
12-
1311
### Reading the Methods online
14-
1512
You’re presently looking at the Method’s GitHub (code) repository. Please [visit our homepage](https://methods.18f.gov) to read the Methods online.
16-
1713
### Printing the Methods
18-
1914
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.
20-
2115
### Running the Methods website on your local machine
2216

2317
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.
@@ -30,7 +24,8 @@ $ brew update
3024
$ brew install ruby
3125
```
3226

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

3530
```
3631
git clone [email protected]:18F/methods
@@ -40,12 +35,8 @@ jekyll serve
4035
```
4136

4237
You should be able to see the site at: `http://localhost:4000/`
43-
44-
45-
## We follow the 18F style guide
46-
47-
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.
48-
38+
### Contributing to the Methods
39+
For more information on contributing to the Methods (or even making a suggestion), see [CONTRIBUTING.md](contributing.md).
4940
## Current team
5041

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

5546
## Past contributors
5647

48+
- Melissa Braxton
5749
- Jeremy Canfield
5850
- Erica Deahl
5951
- Carolyn Dew
6052
- James Hupp
53+
- Nicky Krause
6154
- Colin MacArthur
6255
- Brad Nunnally
6356
- Jennifer Thibault
6457
- Russ Unger
6558
- Victor Zapanta
6659

6760
## Public domain
61+
6862
This project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md):
6963
> 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/).
7064
>
71-
> All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply
72-
>with this waiver of copyright interest.
65+
> 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 commit comments

Comments
 (0)