Skip to content

Commit fbac53a

Browse files
committed
Merge pull request #1 from virtix/master
Add licensing template files
2 parents 5d49a53 + 5fa60b8 commit fbac53a

File tree

5 files changed

+166
-3
lines changed

5 files changed

+166
-3
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
3+

CONTRIBUTING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Guidance on how to contribute
2+
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.
6+
> Details can be found in our [TERMS](TERMS.md) and [LICENCE](LICENSE).
7+
8+
9+
There are two primary ways to help:
10+
- Using the issue tracker, and
11+
- Changing the code-base.
12+
13+
14+
## Using the issue tracker
15+
16+
Use the issue tracker to suggest feature requests, report bugs, and ask questions.
17+
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.
19+
20+
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_
22+
guidance below.
23+
24+
25+
## Changing the code-base
26+
27+
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
29+
tests that validate implemented features and the presence or lack of defects.
30+
Additionally, the code should follow any stylistic and architectural guidelines
31+
prescribed by the project. In the absence of such guidelines, mimic the styles
32+
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: 63 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,64 @@
1-
open-source-project-template
2-
============================
1+
#### CFPB Open Source Project Template Instructions
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
9+
10+
> Keep the README fresh! It's the first thing people see and will make the initial impression.
11+
12+
----
13+
14+
# Project Title
15+
16+
**Description**: Put a meaningful, short, plain-language description of what
17+
this project is trying to accomplish and why it matters.
18+
19+
Other things to include:
20+
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)
22+
- **Links to production or demo instances**
23+
- Describe what sets this apart from related-projects. Again, a link to another doc is OK if this can't be expressed in a sentence or two
24+
25+
26+
**Screenshot**: If the software has visual components, place a screenshot after the description; e.g.—
27+
28+
![](https://raw.githubusercontent.com/virtix/open-source-project-template/master/screenshot.png)
29+
30+
31+
## How to get this running or how to use it
32+
33+
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
35+
another page is fine, but it's important that this works.
36+
37+
38+
## Getting involved
39+
40+
This section should detail why people should get involved and describe key areas you are
41+
currently focusing on; e.g., trying to get feedback on features, fixing certain bugs, building
42+
important pieces, etc.
43+
44+
General instructions on _how_ to contribute should be stated with a link(CONTRIBUTING.md)
45+
46+
47+
____
48+
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/)
53+
54+
55+
----
56+
57+
### Credits and References
58+
59+
1. Projects that inspired you
60+
2. Related projects
61+
3. Book, papers, or other writings that
62+
63+
364

4-
A project template containing default open source files for new projects

TERMS.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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.
3+
Additionally, we waive copyright and related rights in the work worldwide
4+
through the CC0 1.0 Universal public domain dedication.
5+
6+
Software source code previously released under an open source license and then
7+
modified by CFPB staff or its contractors is considered a "joint work" (see 17 USC § 101);
8+
it is partially copyrighted, partially public domain, and as a whole is protected by
9+
the copyrights of the non-government authors and must be released according to
10+
the terms of the original open-source license.
11+
12+
For further details, please see the CFPB [Source Code Policy][policy].
13+
14+
15+
## CC0 1.0 Universal Summary
16+
17+
This is a human-readable summary of the [Legal Code (read the full text)][CC0].
18+
19+
### No Copyright
20+
21+
The person who associated a work with this deed has dedicated the work to
22+
the public domain by waiving all of his or her rights to the work worldwide
23+
under copyright law, including all related and neighboring rights, to the
24+
extent allowed by law.
25+
26+
You can copy, modify, distribute and perform the work, even for commercial
27+
purposes, all without asking permission. See Other Information below.
28+
29+
### Other Information
30+
31+
In no way are the patent or trademark rights of any person affected by CC0,
32+
nor are the rights that other persons may have in the work or in how the
33+
work is used, such as publicity or privacy rights.
34+
35+
Unless expressly stated otherwise, the person who associated a work with
36+
this deed makes no warranties about the work, and disclaims liability for
37+
all uses of the work, to the fullest extent permitted by applicable law.
38+
When using or citing the work, you should not imply endorsement by the
39+
author or the affirmer.
40+
41+
[policy]: http://github.com/cfpb/source-code-policy/
42+
[CC0]: http://creativecommons.org/publicdomain/zero/1.0/legalcode
43+
44+
45+
## Exceptions
46+
47+
_:Source code or other assets that are excluded from the TERMS should be listed
48+
here. These may include dependencies that may be licensed differently or are
49+
not in the public domain._
50+
51+
52+
53+
54+
55+

screenshot.png

137 KB
Loading

0 commit comments

Comments
 (0)