|
1 | 1 | #### CFPB Open Source Project Template Instructions
|
2 | 2 |
|
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. |
9 | 11 |
|
10 | 12 | > Keep the README fresh! It's the first thing people see and will make the initial impression.
|
11 | 13 |
|
12 | 14 | ----
|
13 | 15 |
|
14 | 16 | # Project Title
|
15 | 17 |
|
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. |
18 | 20 |
|
19 | 21 | Other things to include:
|
20 | 22 |
|
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). |
22 | 24 | - **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. |
24 | 26 |
|
25 | 27 |
|
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., |
27 | 29 |
|
28 | 30 | 
|
29 | 31 |
|
30 | 32 |
|
31 | 33 | ## How to get this running or how to use it
|
32 | 34 |
|
33 | 35 | 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 |
35 | 37 | another page is fine, but it's important that this works.
|
36 | 38 |
|
37 | 39 |
|
38 | 40 | ## Getting involved
|
39 | 41 |
|
40 | 42 | This section should detail why people should get involved and describe key areas you are
|
41 | 43 | currently focusing on; e.g., trying to get feedback on features, fixing certain bugs, building
|
42 |
| -important pieces, etc. |
| 44 | +important pieces, etc. |
43 | 45 |
|
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). |
45 | 47 |
|
46 | 48 |
|
47 |
| -____ |
| 49 | +---- |
48 | 50 |
|
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/) |
53 | 55 |
|
54 | 56 |
|
55 | 57 | ----
|
56 | 58 |
|
57 |
| -## Credits and References |
| 59 | +## Credits and references |
58 | 60 |
|
59 | 61 | 1. Projects that inspired you
|
60 | 62 | 2. Related projects
|
61 | 63 | 3. Books, papers, talks, or other sources that have meaniginful impact or influence on this project
|
62 |
| - |
63 |
| - |
64 |
| - |
0 commit comments