generated from cfpb/open-source-project-template
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 3235fb4
Showing
13 changed files
with
693 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
/CHANGELOG.md merge=union |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
Short description explaining the high-level reason for the new issue. | ||
|
||
## Current behavior | ||
|
||
|
||
## Expected behavior | ||
|
||
|
||
## Steps to replicate behavior (include URLs) | ||
|
||
1. | ||
|
||
|
||
## Screenshots | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
[Short description explaining the high-level reason for the pull request] | ||
|
||
## Additions | ||
|
||
- | ||
|
||
## Removals | ||
|
||
- | ||
|
||
## Changes | ||
|
||
- | ||
|
||
## Testing | ||
|
||
1. | ||
|
||
## Screenshots | ||
|
||
|
||
## Notes | ||
|
||
- | ||
|
||
## Todos | ||
|
||
- | ||
|
||
## Checklist | ||
|
||
- [ ] PR has an informative and human-readable title | ||
- [ ] Changes are limited to a single goal (no scope creep) | ||
- [ ] Code can be automatically merged (no conflicts) | ||
- [ ] Code follows the standards laid out in the [development playbook](https://github.com/cfpb/development) | ||
- [ ] Passes all existing automated tests | ||
- [ ] Any _change_ in functionality is tested | ||
- [ ] New functions are documented (with a description, list of inputs, and expected output) | ||
- [ ] Placeholder code is flagged / future todos are captured in comments | ||
- [ ] Visually tested in supported browsers and devices (see checklist below :point_down:) | ||
- [ ] Project documentation has been updated (including the "Unreleased" section of the CHANGELOG) | ||
- [ ] Reviewers requested with the [Reviewers tool](https://help.github.com/articles/requesting-a-pull-request-review/) :arrow_right: | ||
|
||
## Testing checklist | ||
|
||
### Browsers | ||
|
||
- [ ] Chrome | ||
- [ ] Firefox | ||
- [ ] Safari | ||
- [ ] Internet Explorer 8, 9, 10, and 11 | ||
- [ ] Edge | ||
- [ ] iOS Safari | ||
- [ ] Chrome for Android | ||
|
||
### Accessibility | ||
|
||
- [ ] Keyboard friendly | ||
- [ ] Screen reader friendly | ||
|
||
### Other | ||
|
||
- [ ] Is useable without CSS | ||
- [ ] Is useable without JS | ||
- [ ] Flexible from small to large screens | ||
- [ ] No linting errors or warnings | ||
- [ ] JavaScript tests are passing |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
# Compiled source # | ||
################### | ||
*.com | ||
*.class | ||
*.dll | ||
*.exe | ||
*.o | ||
*.so | ||
_site/ | ||
|
||
# Packages # | ||
############ | ||
# it's better to unpack these files and commit the raw source | ||
# git has its own built in compression methods | ||
*.7z | ||
*.dmg | ||
*.gz | ||
*.iso | ||
*.jar | ||
*.rar | ||
*.tar | ||
*.zip | ||
|
||
# Logs and databases # | ||
###################### | ||
*.log | ||
*.sql | ||
*.sqlite | ||
|
||
# OS generated files # | ||
###################### | ||
.DS_Store | ||
.DS_Store? | ||
.Spotlight-V100 | ||
.Trashes | ||
Icon? | ||
ehthumbs.db | ||
Thumbs.db | ||
|
||
# Vim swap files # | ||
################## | ||
*.swp | ||
|
||
# Python # | ||
################# | ||
*.pyc | ||
*.egg-info/ | ||
__pycache__/ | ||
*.py[cod] | ||
.env | ||
.python-version | ||
|
||
# pyenv # | ||
######### | ||
.python-version | ||
|
||
# Django # | ||
################# | ||
*.egg-info | ||
.installed.cfg | ||
|
||
# Unit test / coverage reports | ||
################# | ||
htmlcov/ | ||
.tox/ | ||
.coverage | ||
.cache | ||
nosetests.xml | ||
coverage.xml | ||
|
||
# Front-End # | ||
############# | ||
node_modules/ | ||
bower_components/ | ||
.grunt/ | ||
src/vendor/ | ||
dist/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
All notable changes to this project will be documented in this file. | ||
We follow the [Semantic Versioning 2.0.0](http://semver.org/) format. | ||
|
||
|
||
## x.y.z - YYYY-MM-DD | ||
|
||
### Added | ||
- Lorem ipsum dolor sit amet | ||
|
||
### Deprecated | ||
- Nothing. | ||
|
||
### Removed | ||
- Nothing. | ||
|
||
### Fixed | ||
- Nothing. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
# CFPB Open Source Code of Conduct | ||
|
||
## Introduction | ||
|
||
The [Consumer Financial Protection Bureau](https://www.consumerfinance.gov) (CFPB) is committed to | ||
building a safe, welcoming, harassment-free culture for everyone. We do not merely want an | ||
environment that is free from hostility, we want one that is actively welcoming and inclusive. We | ||
want our team, our workplace culture, and our open source community to reflect and celebrate the | ||
diversity of the people we serve. | ||
|
||
This Code of Conduct summarizes federal anti-harassment law and CFPB policy. | ||
|
||
## Scope | ||
|
||
We expect everyone on the CFPB team, and those contributing to our open source community, to exhibit | ||
these behaviors and abide by applicable federal laws and CFPB policies. In addition, we expect | ||
everyone within CFPB spaces to exhibit these behaviors and refrain from behavior prohibited by | ||
anti-harassment laws and federal policies on harassment. These spaces include: | ||
|
||
- CFPB’s physical offices | ||
- CFPB events and meetings | ||
- All of CFPB’s online forums and virtual collaboration tools, including code repositories | ||
|
||
|
||
## What we strive for | ||
|
||
At the CFPB, we strive to create a welcoming and inclusive culture that empowers people to best protect | ||
the financial interests of all consumers. That kind of atmosphere requires an open exchange of ideas | ||
balanced by thoughtful guidelines. Examples of behavior that contributes to a positive environment | ||
for our open source community include: | ||
|
||
- Demonstrating empathy and kindness toward other people | ||
- Being respectful of differing opinions, viewpoints, and experiences | ||
- Giving and gracefully accepting constructive feedback | ||
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience | ||
- Focusing on what is best not just for us as individuals, but for the overall community and public | ||
|
||
## Unacceptable behavior | ||
|
||
To help understand the kinds of behaviors that are illegal or run counter to the culture we seek to | ||
foster, we've listed some actions below that violate federal law and CFPB policy. We've also included | ||
steps to take if you encounter behavior that runs contrary to this policy. | ||
|
||
The CFPB Policy Statement on Equal Employment Opportunity and Workplace Harassment forbids | ||
discrimination or harassment based on: | ||
|
||
- Race | ||
- Color | ||
- Religion | ||
- Sex (including pregnancy, sexual orientation, transgender status, gender identity or expression, gender non-conformity, or sex stereotyping of any kind) | ||
- National origin | ||
- Disability | ||
- Age (40 years or older) | ||
- Genetic information | ||
- Parental status | ||
- Political affiliation | ||
- Marital status | ||
- Uniformed status | ||
- Membership in a labor organization or union activities | ||
- Prior equal employment opportunity (EEO) or whistleblower activity | ||
- Any other factor unrelated to your merit | ||
|
||
The policy also forbids harassing conduct, which includes unwelcome conduct based on any (or a combination of) protected traits or characteristics. Such conduct may take the form of any of the following: | ||
|
||
- Offensive jokes, comments, objects, or pictures | ||
- Questions about a person’s identity (e.g., disability status, gender identity, sexual orientation, national origin, etc.) | ||
- Undue attention | ||
- Ridicule or mockery | ||
- Insults or put-downs | ||
- Touching/physical contact | ||
- Slurs or epithets | ||
- Threats or other forms of intimidation | ||
- Physical or sexual assault | ||
|
||
## Reporting violations | ||
|
||
If you are a CFPB employee, former CFPB employee, or job applicant to CFPB and believe you have been | ||
discriminated against or harassed on the basis of race, color, religion, sex (including pregnancy, | ||
sexual orientation, transgender status, gender identity or expression, gender non-conformity, or sex | ||
stereotyping of any kind), national origin, disability, age (40 years or older), genetic information, | ||
parental status, or retaliated against for prior Equal Employment Opportunity (EEO) activity, contact the CFPB’s Office of Civil Rights. | ||
|
||
[email protected] | ||
|
||
(202) 435-9EEO | ||
(855) 233-0362 | ||
TTY: (202) 435-9742 | ||
|
||
Office of Civil Rights | ||
Consumer Financial Protection Bureau | ||
1700 G Street, NW | ||
Washington, D.C. 20552 | ||
|
||
For help filing a complaint about discrimination on the basis of marital status, political | ||
affiliation, or any other non-merit factor, or for claims of retaliation for [whistleblower activity](https://www.consumerfinance.gov/office-civil-rights/whistleblowers/), contact the [Office of Special Counsel](https://www.osc.gov/) or the [Merit Systems Protection Board](https://www.mspb.gov/). | ||
|
||
For help filing a complaint about discrimination on the basis of uniformed status, you may contact | ||
the [Veterans’ Employment and Training Service (VETS)](https://www.dol.gov/vets/) at the Department of Labor, the [Merit Systems Protection Board](https://www.mspb.gov/), or the [Office of Special Counsel](https://osc.gov/), depending on the circumstances. | ||
|
||
For help filing a complaint about discrimination on the basis of membership in a labor organization, | ||
you may contact the [Federal Labor Relations Authority](https://flra.gov/) or your union (if applicable). | ||
|
||
### Equal employment opportunity policy | ||
|
||
For more information about the CFPB’s equal employment opportunity (EEO) policies and procedures visit https://www.consumerfinance.gov/office-civil-rights/eeo-policy-and-reports/ | ||
|
||
## Credits | ||
|
||
The CFPB is greatly appreciative of the multiple sources that we drew from to build this Code of Conduct, including: | ||
|
||
- [The Technology Transformation Services (TTS) Code of Conduct](https://18f.gsa.gov/code-of-conduct/) | ||
- [The Contributor Covenant](https://www.contributor-covenant.org/) | ||
- [Code for America Code of Conduct](https://github.com/codeforamerica/codeofconduct) | ||
- [Ada Initiative: HOWTO design a code of conduct for your community](https://adainitiative.org/2014/02/18/howto-design-a-code-of-conduct-for-your-community/) | ||
- [Geek Feminism Code of Conduct](https://geekfeminismdotorg.wordpress.com/about/code-of-conduct/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Guidance on how to contribute | ||
|
||
> All contributions to this project will be released under the CC0 public domain | ||
> dedication. By submitting a pull request or filing a bug, issue, or | ||
> feature request, you are agreeing to comply with this waiver of copyright interest. | ||
> Details can be found in our [TERMS](TERMS.md) and [LICENSE](LICENSE). | ||
|
||
There are two primary ways to help: | ||
- Using the issue tracker, and | ||
- Changing the code-base. | ||
|
||
|
||
## Using the issue tracker | ||
|
||
Use the issue tracker to suggest feature requests, report bugs, and ask questions. | ||
This is also a great way to connect with the developers of the project as well | ||
as others who are interested in this solution. | ||
|
||
Use the issue tracker to find ways to contribute. Find a bug or a feature, mention in | ||
the issue that you will take on that effort, then follow the _Changing the code-base_ | ||
guidance below. | ||
|
||
|
||
## Changing the code-base | ||
|
||
Generally speaking, you should fork this repository, make changes in your | ||
own fork, and then submit a pull request. All new code should have associated | ||
unit tests that validate implemented features and the presence or lack of defects. | ||
Additionally, the code should follow any stylistic and architectural guidelines | ||
prescribed by the project. In the absence of such guidelines, mimic the styles | ||
and patterns in the existing code-base. | ||
|
||
|
||
## Browser support | ||
|
||
We configure our build chain tools | ||
(typically [Autoprefixer](https://github.com/postcss/autoprefixer) | ||
and [Babel](https://babeljs.io)) | ||
to support a reasonable set of backward compatibility with older browsers. | ||
|
||
Please read up on | ||
[our current browser support guidance](https://github.com/cfpb/development/blob/main/guides/browser-support.md) | ||
and follow it when contributing to this project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Installation instructions | ||
|
||
Detailed instructions on how to install, configure, and get the project running. |
Oops, something went wrong.