Skip to content

Commit 0324e30

Browse files
committed
Merge pull request #3 from Scotchester/master
Some copyediting and suggestions
2 parents b7a7a7c + 8a34c32 commit 0324e30

File tree

3 files changed

+29
-43
lines changed

3 files changed

+29
-43
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Guidance on how to contribute
22

3-
> All contributions to this project will be released under the CC0
4-
> dedication. By submitting a pull request, or filing a bug, issue, or
5-
> feature-request you are agreeing to comply with this waiver of copyright interest.
3+
> All contributions to this project will be released under the CC0 public domain
4+
> dedication. By submitting a pull request or filing a bug, issue, or
5+
> feature request, you are agreeing to comply with this waiver of copyright interest.
66
> Details can be found in our [TERMS](TERMS.md) and [LICENCE](LICENSE).
77
88

@@ -25,21 +25,8 @@ guidance below.
2525
## Changing the code-base
2626

2727
Generally speaking, you should fork this repository, make changes in your
28-
own fork, and then submit a pull-request. All new code should have associated unit
28+
own fork, and then submit a pull-request. All new code should have associated unit
2929
tests that validate implemented features and the presence or lack of defects.
3030
Additionally, the code should follow any stylistic and architectural guidelines
3131
prescribed by the project. In the absence of such guidelines, mimic the styles
3232
and patterns in the existing code-base.
33-
34-
----
35-
36-
## Public domain
37-
38-
The project is in the public domain within the United States, and
39-
copyright and related rights in the work worldwide are waived through
40-
the [CC0 1.0 Universal public domain dedication][CC0].
41-
42-
43-
[CC0]: http://creativecommons.org/publicdomain/zero/1.0/
44-
45-

README.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,63 @@
11
#### CFPB Open Source Project Template Instructions
22

3-
1. Create a new project
4-
2. Copy these files into the new project
5-
3. Update the README, replacing the contents below as prescribed
6-
4. Add any libraries, assets, or hard dependencies to the _Exceptions_ section in the [TERMS](TERMS.md)
7-
5. Delete these instructions and everything up to the _Project Title_ from the README
8-
6. Write some great software and tell people about it
3+
1. Create a new project.
4+
2. Copy these files into the new project.
5+
3. Update the README, replacing the contents below as prescribed.
6+
4. Add any libraries, assets, or hard dependencies whose source code will be included
7+
in the project's repository to the _Exceptions_ section in the [TERMS](TERMS.md).
8+
- If no exceptions are needed, remove that section from TERMS.
9+
5. Delete these instructions and everything up to the _Project Title_ from the README.
10+
6. Write some great software and tell people about it.
911

1012
> Keep the README fresh! It's the first thing people see and will make the initial impression.
1113
1214
----
1315

1416
# Project Title
1517

16-
**Description**: Put a meaningful, short, plain-language description of what
17-
this project is trying to accomplish and why it matters.
18+
**Description**: Put a meaningful, short, plain-language description of what
19+
this project is trying to accomplish and why it matters.
1820

1921
Other things to include:
2022

21-
- **Status**: Alpha, Beta, 1.1, etc. It's OK to write a sentence, too. The goal is to let interested people know where this project is at. This is also a good place to link to the [CHANGELOG](CHANGELOG.md)
23+
- **Status**: Alpha, Beta, 1.1, etc. It's OK to write a sentence, too. The goal is to let interested people know where this project is at. This is also a good place to link to the [CHANGELOG](CHANGELOG.md).
2224
- **Links to production or demo instances**
23-
- Describe what sets this apart from related-projects. Linking to another doc or page is OK if this can't be expressed in a sentence or two
25+
- Describe what sets this apart from related-projects. Linking to another doc or page is OK if this can't be expressed in a sentence or two.
2426

2527

26-
**Screenshot**: If the software has visual components, place a screenshot after the description; e.g.—
28+
**Screenshot**: If the software has visual components, place a screenshot after the description; e.g.,
2729

2830
![](https://raw.githubusercontent.com/cfpb/open-source-project-template/master/screenshot.png)
2931

3032

3133
## How to get this running or how to use it
3234

3335
Detailed instructions on how to install, configure, and get the project running.
34-
This should be frequently tested to ensure reliability. Alternatively, a link to
36+
This should be frequently tested to ensure reliability. Alternatively, a link to
3537
another page is fine, but it's important that this works.
3638

3739

3840
## Getting involved
3941

4042
This section should detail why people should get involved and describe key areas you are
4143
currently focusing on; e.g., trying to get feedback on features, fixing certain bugs, building
42-
important pieces, etc.
44+
important pieces, etc.
4345

44-
General instructions on _how_ to contribute should be stated with a link to [CONTRIBUTING.md](CONTRIBUTING.md)
46+
General instructions on _how_ to contribute should be stated with a link to [CONTRIBUTING](CONTRIBUTING.md).
4547

4648

47-
____
49+
----
4850

49-
## Open Source Licensing Info
50-
1. [LICENSE](LICENSE)
51-
2. [TERMS](TERMS.md)
52-
3. [CFPB Source Code Policy](http://github.com/cfpb/source-code-policy/)
51+
## Open source licensing info
52+
1. [TERMS](TERMS.md)
53+
2. [LICENSE](LICENSE)
54+
3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)
5355

5456

5557
----
5658

57-
## Credits and References
59+
## Credits and references
5860

5961
1. Projects that inspired you
6062
2. Related projects
6163
3. Books, papers, talks, or other sources that have meaniginful impact or influence on this project
62-
63-
64-

TERMS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
As a work of the United States Government, this package (excluding the
2-
exceptions below) is in the public domain within the United States.
1+
As a work of the United States Government, this package (excluding any
2+
exceptions listed below) is in the public domain within the United States.
33
Additionally, we waive copyright and related rights in the work worldwide
44
through the CC0 1.0 Universal public domain dedication.
55

@@ -44,7 +44,7 @@ author or the affirmer.
4444

4545
## Exceptions
4646

47-
_:Source code or other assets that are excluded from the TERMS should be listed
47+
_Source code or other assets that are excluded from the TERMS should be listed
4848
here. These may include dependencies that may be licensed differently or are
4949
not in the public domain._
5050

0 commit comments

Comments
 (0)