You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thanks for your interest in contributing to the 18F Methods! We appreciate all constructive contributions, and we welcome your ideas about how to keep the Methods up-to-date, friendly, and accessible. You can contribute by emailing us, filing an issue, or submitting a pull request.
2
2
3
-
We’re so glad you’re thinking about contributing to an 18F open source project! If you’re unsure about something, feel free to submit your issue or pull request anyway. The worst that can happen is you’ll be politely asked to change something. We love all friendly contributions and questions.
3
+
-**Emailing us.** Whether you've got a general question about the Methods, or you'd just like to have a conversation outside of GitHub — whatever the reason, feel free to [email us](mailto:[email protected]).
4
+
-**Filing an issue.** See something amiss? Please glance through the [existing issues](https://github.com/18f/methods/issues) to see if someone has already alerted us to your question or concern *before*[filing a new issue](https://github.com/18F/methods/issues/new)! (Please note that we tag and manage issues using [a specific set of labels](https://github.com/18F/methods/wiki/labels).)
5
+
-**Submitting a pull request.** Got a better solution in mind? Please glance through [our existing pull requests](https://github.com/18f/methods/pulls) to see if we're already working on a similar idea *before* submitting a pull request.
4
6
5
-
We want to ensure a welcoming environment for all of our projects. Our staff follow the [18F Code of Conduct](https://github.com/18F/code-of-conduct/blob/master/code-of-conduct.md) and all contributors should do the same.
7
+
## Code of conduct
8
+
To ensure a welcoming environment for our projects, our staff follows the [18F Code of Conduct](https://github.com/18F/code-of-conduct/blob/master/code-of-conduct.md); contributors should do the same.
6
9
7
-
We encourage you to read this project’s CONTRIBUTING policy (you are here), its [LICENSE](LICENSE.md), and its [README](README.md).
8
-
9
-
If you have any questions or want to read more, check out the [18F Open Source Policy GitHub repository](https://github.com/18f/open-source-policy), or just [shoot us an email](mailto:[email protected]).
10
-
11
-
## How to contribute
12
-
13
-
### Where to submit a pull request
14
-
15
-
Submit pull requests to the `18f-pages-staging` branch. This is the main branch of Methods. If you’re not sure how to submit a pull request, feel free to submit an issue and we will try to address it ourselves.
16
-
17
-
### What to include in a pull request
18
-
19
-
Including these will help us be faster and better at responding.
20
-
21
-
-**Changes:** a list, preferably bulleted, of what you’re changing
22
-
-**Notes:** anything that might help us understand the change, like why you’re doing it or alternative approaches you tried
23
-
-**Screenshots:** if your pull request will affect layout or interaction, to show us what you’re fixing or changing
24
-
25
-
### Issues and labels
26
-
27
-
If there’s anything you’d like to understand about Methods, submit an issue about it. If you see something that should be fixed but don’t want to do so yourself, submit an issue. If you have an idea for an improvement... well, you get the idea.
28
-
29
-
This is the list of labels we currently use for different types of issues. It should give you some idea of the sorts of issues we expect. (You can also apply these labels to pull requests.) But if you want to raise something else, go for it.
30
-
31
-
-`bug` tells us that Methods is doing something it probably should not. Try to keep this to interactive, layout, or visual design issues for the digital version. Print design issues should go under `print cards`.
32
-
-`copy edit` denotes changes to language, which tells us we need to make the change twice: in the digital version and on the printable method cards. Even if the issue only exists in one place, we want to check it in both.
33
-
-`duplicate` suggests that this issue might be the same as another issue. If you tell us what issue that is, we will look into it and decide whether to combine them.
34
-
-`enhancement` means you’re suggesting a way to make Methods better. This is different from `bug` because it’s not suggesting there’s something wrong with the current state.
35
-
-`help wanted` is a request for assistance, usually by 18F to the world, but if you just can’t figure something out about something you’re trying to do with Methods, feel free to use this label.
36
-
-`invalid` comes after the fact to say the issue is either inaccurate or misplaced.
37
-
-`new method` tells us you are submitting a design research method that we don’t currently describe.
38
-
-`print cards` is for design changes to the printable cards that may require a bit more time from an 18F visual designer to address.
39
-
-`question` raises any kind of question at all you have about Methods.
40
-
-`wontfix` should come from 18F staffers. It acknowledges the issue — usually a bug or enhancement — but says we are not going to do something with it. You should expect an explanation if we apply this label.
41
-
-`work in progress` means we are in the process of addressing this issue.
42
-
43
-
### What to include in an issue
44
-
45
-
Not all of these will apply to all issues. But when they do, it’s very helpful to see them (special thanks to @ondrae for [the suggestion of this list](https://github.com/18F/open-source-guide/issues/15#issuecomment-129552978)).
46
-
47
-
-**Description:** okay, this one does apply to all issues. :)
48
-
-**How to reproduce:** if your issue is a bug, any information about how we can see it ourselves
49
-
-**Screenshots:** similarly, so we can see what you’re seeing
50
-
-**Files:** anything with helpful information about the issue
51
-
-**To dos:** if your issue is an enhancement, a list of improvements or steps to help us meet the goal of the enhancement
52
-
53
-
54
-
### Before you submit content edits
55
-
56
-
Please review the Methods [content editing checklist](https://github.com/18F/methods/wiki/content-editing-checklist). We’re trying to keep the style and structure consistent, so we’ll check contributions against this guide anyway. Might as well check beforehand! If you’d rather just call our attention to something that seems off, go ahead and file an issue and we’ll review the checklist as part of our edits.
57
-
58
-
## What we do with contributions
59
-
60
-
We regularly review all pull requests and issues. We merge pull requests into `18f-pages-staging` as soon as we can.
61
-
62
-
Once a week, we incorporate any staged copy edits into the files for the printed cards, also on `18f-pages-staging`. We then merge all changes from `18f-pages-staging` into `master` — code and copy, digital and print. You’ll see your change reflected on [methods.18f.gov](https://methods.18f.gov/) after that pull into `master`.
63
-
64
-
We leave issues and pull requests open until we have decided what to do and then actually done it. Any time we close an issue, you’ll see something that explains why we’re closing it (such as a comment, a merged pull request, or a reference to another issue).
10
+
## Open source
11
+
This project is maintained in accordance with [18F’s Open Source Policy](https://github.com/18f/open-source-policy).
65
12
66
13
## Public domain
67
-
68
14
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/).
69
-
70
15
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.
REMINDERS (Delete this before submitting your issue)
2
+
3
+
Labels: Please label your issue in accordance with our label descriptions. See our wiki for more information: https://github.com/18F/methods/wiki/labels
4
+
5
+
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.
6
+
7
+
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.
REMINDERS (Delete this before submitting your pull request)
2
+
3
+
Before submitting your pull request, please preview your changes at https://federalist-proxy.app.cloud.gov/preview/18f/methods/[BRANCHNAME] (where [BRANCHNAME] is the name of your branch) This is the main URL we will reference as we review and comment on your pull request.
4
+
5
+
Please submit pull requests against the `staging` branch.
6
+
7
+
Finally, please note that all pull requests must receive at least one review in addition to whomever merges the request. When you believe your code is ready to merge, please tag at least one member of the current Methods team (see README.md).
The 18F Method Cards (“18F Methods”) describe how 18F puts human-centered design into practice. While this is primarily maintained as an internal resource, we hope it can help *everyone* adopt the methods of human-centered design.
3
2
4
-
## Why method cards?
3
+
###Why methods?
5
4
6
-
- To add rigor and structure to agile development.
7
-
- To build a shared vocabulary for each method among 18F staff and our partner agencies.
8
-
- To give less experienced or new researchers a gateway into well-documented and proven research methods, supported by other 18F team members.
5
+
In order to function well within cross-functional teams, designers need to know a few things: which methods they might choose from, why one particular method makes more sense than another at any given moment, and, once they’ve picked a method, how to actually execute it. 18F Methods collects this essential information as a series of cards. In practice, we’ve found the Methods can provide folks with a gateway into our work and build internal alignment around a shared vocabulary.
9
6
10
-
##We’ve grouped these methods into four phases
7
+
### Specific to 18F, specific to the federal government
11
8
12
-
-**Discover**: Learn as much as you can about the project and people involved.
13
-
-**Decide**: Use what you’ve learned to start focusing your research on specific areas and groups of people.
14
-
-**Make**: Move toward a final product that’s ready to be released and tested.
15
-
-**Validate**: Test your research, design, and product.
9
+
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
+
## Getting started
11
+
### Reading the Methods online
12
+
You’re presently looking at the Methods’ GitHub (code) repository. Please [visit our homepage](https://methods.18f.gov) to read the Methods online.
13
+
### Printing the Methods
14
+
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.
15
+
### Running the Methods website on your local machine
16
16
17
-
## We’ve called out specifics about doing this work in government.
17
+
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.
18
18
19
-
For the most part, the processes are the same as anywhere. However, to stay on the happy side of the law, take a look at [Recruiting](pages/recruiting/), [Incentives](pages/incentives/), [Informed consent](pages/informed-consent/), [Privacy](pages/privacy/), and the [Paperwork Reduction Act](pages/paperwork-reduction-act/). No matter which methods we work with, these are the [fundamentals](pages/fundamentals/) of our design research.
19
+
On OS X, you can use [Homebrew](http://brew.sh/) to install Ruby in `/usr/local/bin`, which may require you to update your `$PATH` environment variable:
20
20
21
-
## Generating the Methods site/hosting locally
22
-
23
-
### Cloning and running 18F/methods
24
-
25
-
You will need [Ruby](https://www.ruby-lang.org) ( > version 2.1.5 ). You may
26
-
consider using a Ruby version manager such as
27
-
[rbenv](https://github.com/sstephenson/rbenv) or [rvm](https://rvm.io/) to
28
-
help ensure that Ruby version upgrades don’t mean all your
29
-
[gems](https://rubygems.org/) will need to be rebuilt.
30
-
31
-
On OS X, you can use [Homebrew](http://brew.sh/) to install Ruby in
32
-
`/usr/local/bin`, which may require you to update your `$PATH` environment
33
-
variable:
34
-
35
-
```shell
21
+
```
22
+
shell
36
23
$ brew update
37
24
$ brew install ruby
38
25
```
39
26
40
-
To serve 18F Design Methods locally, using `METHODS` as the name of your new repository:
41
-
27
+
To serve 18F Methods locally, using `methods` as the name of your new repository:
42
28
Run each of the following steps to get the site up and running.
43
29
44
30
```
@@ -48,36 +34,33 @@ bundle install
48
34
jekyll serve
49
35
```
50
36
51
-
You should be able to see the site at: http://localhost:4000/
52
-
53
-
### Forking into your own repository
54
-
55
-
If you haven’t already followed the cloning instructions above, the easiest way to do this is simply to go to https://github.com/18F/methods and click `Fork`, then set up the repository under your own username. Then follow the instructions above to clone locally, subbing in MY-USER-NAME for 18F’s in the URL that follows `git clone`.
56
-
57
-
If you _have_ already cloned locally from 18F and want to maintain your own Methods repository, do the following.
58
-
59
-
You’ll need to create a new repository on Github. To do this, go to github.com/MY-USER-NAME and click the "New Repository" button. Enter the title and description for your new guide and then click `Create Repository`. It’s easiest if you use `methods` as the name, as it will match back to the 18F Methods you’re building from.
60
-
61
-
After the repository is created, you’ll see the repository URL at the top. Copy this url by hitting the handy `Copy to Clipboard` button next to the text box.
62
-
63
-
Go back to the directory where you cloned the repository. We’re going to change this repo to point to the one you just created (which is empty), instead of back to 18F’s, and push to it.
Now you can edit your own fork of Methods freely, and push up changes as you need.
70
-
71
-
## We follow the 18F style guide
72
-
73
-
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.
37
+
You should be able to see the site at: `http://localhost:4000/`
38
+
### Contributing to the Methods
39
+
For more information on contributing to the Methods (or even making a suggestion), see [CONTRIBUTING.md](https://github.com/18F/methods/blob/staging/CONTRIBUTING.md).
40
+
## Current team
41
+
42
+
- Product owner: Eric Ronne
43
+
- Designer (researcher): Andrew Maier
44
+
- Designer (front-end developer): Scott Weber
45
+
46
+
## Past contributors
47
+
48
+
- Melissa Braxton
49
+
- Jeremy Canfield
50
+
- Erica Deahl
51
+
- Carolyn Dew
52
+
- Andre Francisco
53
+
- James Hupp
54
+
- Nicky Krause
55
+
- Colin MacArthur
56
+
- Brad Nunnally
57
+
- Jennifer Thibault
58
+
- Russ Unger
59
+
- Victor Zapanta
74
60
75
61
## Public domain
76
62
77
63
This project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md):
78
-
79
64
> 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/).
80
65
>
81
-
> All contributions to this project will be released under the CC0
82
-
>dedication. By submitting a pull request, you are agreeing to comply
83
-
>with this waiver of copyright interest.
66
+
> 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