#### Components
CFPB Open Source Project Template Instructions
Create a new project.
Copy these files into the new project
Update the README, replacing the contents below as prescribed.
Add any libraries, assets, or hard dependencies whose source code will be included in the project's repository to the Exceptions section in the TERMS.
If no exceptions are needed, remove that section from TERMS.
If working with an existing code base, answer the questions on the open source checklist
Delete these instructions and everything up to the Project Title from the README.
Write some great software and tell people about it.
Keep the README fresh! It's the first thing people see and will make the initial impression.


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

Other things to include:

Technology stack: Indicate the technological nature of the software, including primary programming language(s) and whether the software is intended as standalone or as a module in a framework or other ecosystem.
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.
Links to production or demo instances
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.

#### Mockups / Examples
To install all of the template files, run the following script from the root of your project's directory:

bash -c "$(curl -s https://raw.githubusercontent.com/CFPB/development/master/open-source-template.sh)"

#### Benefits
Show users how to use the software. Be specific. Use appropriate formatting when showing code snippets.

If the software is configurable, describe it in detail, either here or in other documentation to which you link.
https://github.com/cfpb/open-source-project-template

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



![image.png](https://res.cloudinary.com/hpiynhbhq/image/upload/v1516768969/druzdo4i0bvsbrv8gzvj.png)
    
# Credits and references
1. Projects that inspired you
2. Related projects
3. Books, papers, talks, or other sources that have meaningful impact or influence on this project

<br /><hr/><em>Posted on <a href="https://utopian.io/utopian-io/@piyasmarty121287/a-project-template-containing-default-open-source-files-for-new-projects">Utopian.io -  Rewarding Open Source Contributors</a></em><hr/>