Skip to content

Commit da2e879

Browse files
Fixes cfpb#13 - adds INSTALL.md
- Fixes cfpb#13 - adds INSTALL.md
1 parent 5c838e7 commit da2e879

File tree

3 files changed

+20
-17
lines changed

3 files changed

+20
-17
lines changed

CONTRIBUTING.md

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

33
> 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
4+
> dedication. By submitting a pull request or filing a bug, issue, or
55
> 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

9-
There are two primary ways to help:
10-
- Using the issue tracker, and
9+
There are two primary ways to help:
10+
- Using the issue tracker, and
1111
- Changing the code-base.
1212

1313

1414
## Using the issue tracker
1515

16-
Use the issue tracker to suggest feature requests, report bugs, and ask questions.
16+
Use the issue tracker to suggest feature requests, report bugs, and ask questions.
1717
This is also a great way to connect with the developers of the project as well
18-
as others who are interested in this solution.
18+
as others who are interested in this solution.
1919

2020
Use the issue tracker to find ways to contribute. Find a bug or a feature, mention in
21-
the issue that you will take on that effort, then follow the _Changing the code-base_
21+
the issue that you will take on that effort, then follow the _Changing the code-base_
2222
guidance below.
2323

2424

2525
## Changing the code-base
2626

2727
Generally speaking, you should fork this repository, make changes in your
2828
own fork, and then submit a pull-request. All new code should have associated unit
29-
tests that validate implemented features and the presence or lack of defects.
30-
Additionally, the code should follow any stylistic and architectural guidelines
29+
tests that validate implemented features and the presence or lack of defects.
30+
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.

INSTALL.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Installation instructions
2+
3+
Detailed instructions on how to install, configure, and get the project running.

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
4. Add any libraries, assets, or hard dependencies whose source code will be included
77
in the project's repository to the _Exceptions_ section in the [TERMS](TERMS.md).
88
- If no exceptions are needed, remove that section from TERMS.
9-
5. If working with an existing code base, answer the questions on the [open source checklist](opensource-checklist.md)
9+
5. If working with an existing code base, answer the questions on the [open source checklist](opensource-checklist.md)
1010
6. Delete these instructions and everything up to the _Project Title_ from the README.
1111
7. Write some great software and tell people about it.
1212

@@ -17,7 +17,7 @@
1717
# Project Title
1818

1919
**Description**: Put a meaningful, short, plain-language description of what
20-
this project is trying to accomplish and why it matters.
20+
this project is trying to accomplish and why it matters.
2121
Describe the problem(s) this project solves.
2222
Describe how this software can improve the lives of its audience.
2323

@@ -36,24 +36,24 @@ Other things to include:
3636

3737
## Dependencies
3838

39-
Describe any dependencies that must be installed for this software to work.
39+
Describe any dependencies that must be installed for this software to work.
4040
This includes programming languages, databases or other storage mechanisms, build tools, frameworks, and so forth.
41-
If specific versions of other software are required, or or known not to work, call that out.
41+
If specific versions of other software are required, or known not to work, call that out.
4242

4343
## Installation
4444

4545
Detailed instructions on how to install, configure, and get the project running.
46-
This should be frequently tested to ensure reliability. Alternatively, a link to
47-
another page is fine, but it's important that this works.
46+
This should be frequently tested to ensure reliability. Alternatively, link to
47+
a separate [INSTALL](INSTALL.md) document.
4848

4949
## Configuration
5050

5151
If the software is configurable, describe it in detail, either here or in other documentation to which you link.
5252

5353
## Usage
5454

55-
Show users how to use the software.
56-
Be specific.
55+
Show users how to use the software.
56+
Be specific.
5757
Use appropriate formatting when showing code snippets.
5858

5959
## How to test the software
@@ -95,4 +95,4 @@ General instructions on _how_ to contribute should be stated with a link to [CON
9595

9696
1. Projects that inspired you
9797
2. Related projects
98-
3. Books, papers, talks, or other sources that have meaniginful impact or influence on this project
98+
3. Books, papers, talks, or other sources that have meaniginful impact or influence on this project

0 commit comments

Comments
 (0)