forked from widal001/grants-api
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Creating READMEs etc and initial repo structure --------- Co-authored-by: decause-gov <[email protected]>
- Loading branch information
1 parent
a53c847
commit 9c8a08f
Showing
7 changed files
with
703 additions
and
1 deletion.
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,3 @@ | ||
# Files ignored because they're binary/unnecessary | ||
.DS_STORE | ||
.idea |
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,173 @@ | ||
<!--- # NOTE: Modify sections marked with `TODO` and then rename the file.--> | ||
|
||
# How to Contribute | ||
|
||
We're so thankful you're considering contributing to an [open source project of | ||
the U.S. government](https://code.gov/)! If you're unsure about anything, just | ||
ask -- or submit the issue or pull request anyway. The worst that can happen is | ||
you'll be politely asked to change something. We appreciate all friendly | ||
contributions. | ||
|
||
We encourage you to read this project's CONTRIBUTING policy (you are here), its | ||
[LICENSE](LICENSE.md), and its [README](README.md). | ||
|
||
## Getting Started | ||
<!--- ### TODO: If you have 'good-first-issue' or 'easy' labels for newcomers, mention them here.--> | ||
|
||
### Team Specific Guidelines | ||
|
||
### Building dependencies | ||
|
||
<!--- ### TODO --> | ||
|
||
### Building the Project | ||
|
||
<!--- ### TODO --> | ||
|
||
### Workflow and Branching | ||
|
||
<!--- | ||
TODO: Workflow Example | ||
We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow/) | ||
1. Fork the project | ||
1. Check out the `main` branch | ||
1. Create a feature branch | ||
1. Write code and tests for your change | ||
1. From your branch, make a pull request against `hhsgov/grants-api/main` | ||
1. Work with repo maintainers to get your change reviewed | ||
1. Wait for your change to be pulled into `hhsgov/grants-api/main` | ||
1. Delete your feature branch | ||
--> | ||
|
||
### Testing Conventions | ||
|
||
<!--- TODO --> | ||
|
||
### Coding Style and Linters | ||
|
||
<!--- TODO: Code Style Guide | ||
1. Mention any style guides you adhere to (e.g. pep8, etc...) | ||
1. Mention any linters your project uses (e.g. flake8, jslint, etc...) | ||
1. Mention any naming conventions your project uses (e.g. Semantic Versioning, CamelCasing, etc...) | ||
1. Mention any other content guidelines the project adheres to (e.g. plainlanguage.gov, etc...) | ||
--> | ||
|
||
### Issues | ||
|
||
<!--- | ||
TODO: Example Issue Guides | ||
When creating an issue please try to adhere to the following format: | ||
module-name: One line summary of the issue (less than 72 characters) | ||
### Expected behavior | ||
As concisely as possible, describe the expected behavior. | ||
### Actual behavior | ||
As concisely as possible, describe the observed behavior. | ||
### Steps to reproduce the behavior | ||
List all relevant steps to reproduce the observed behavior. | ||
see our .github/ISSUE_TEMPLATE.md for more examples. | ||
--> | ||
|
||
### Pull Requests | ||
|
||
<!--- | ||
### TODO: Confirm | ||
Comments should be formatted to a width no greater than 80 columns. | ||
Files should be exempt of trailing spaces. | ||
We adhere to a specific format for commit messages. Please write your commit | ||
messages along these guidelines. Please keep the line width no greater than 80 | ||
columns (You can use `fmt -n -p -w 80` to accomplish this). | ||
module-name: One line description of your change (less than 72 characters) | ||
Problem | ||
Explain the context and why you're making that change. What is the problem | ||
you're trying to solve? In some cases there is not a problem and this can be | ||
thought of being the motivation for your change. | ||
Solution | ||
Describe the modifications you've done. | ||
Result | ||
What will change as a result of your pull request? Note that sometimes this | ||
section is unnecessary because it is self-explanatory based on the solution. | ||
Some important notes regarding the summary line: | ||
* Describe what was done; not the result | ||
* Use the active voice | ||
* Use the present tense | ||
* Capitalize properly | ||
* Do not end in a period — this is a title/subject | ||
* Prefix the subject with its scope | ||
see our .github/PULL_REQUEST_TEMPLATE.md for more examples. | ||
--> | ||
|
||
## Code Review | ||
|
||
## Documentation | ||
|
||
<!--- | ||
### TODO: Documentation Example | ||
We also welcome improvements to the project documentation or to the existing | ||
docs. Please file an [issue](https://github.com/hhsgov/grants-api/issues). | ||
--> | ||
|
||
## Policies | ||
|
||
### Open Source Policy | ||
|
||
We adhere to the [HHS Open Source | ||
Policy](https://github.com/CMSGov/cms-open-source-policy). If you have any | ||
questions, just [shoot us an email](mailto:email address [email protected]). | ||
|
||
### Security and Responsible Disclosure Policy | ||
|
||
The Centers for Medicare & Medicaid Services is committed to ensuring the | ||
security of the American public by protecting their information from | ||
unwarranted disclosure. We want security researchers to feel comfortable | ||
reporting vulnerabilities they have discovered so we can fix them and keep our | ||
users safe. We developed our disclosure policy to reflect our values and uphold | ||
our sense of responsibility to security researchers who share their expertise | ||
with us in good faith. | ||
|
||
*Submit a vulnerability:* Unfortunately, we cannot accept secure submissions via | ||
email or via GitHub Issues. Please use our website to submit vulnerabilities at | ||
[https://hhs.responsibledisclosure.com](https://hhs.responsibledisclosure.com). | ||
HHS maintains an acknowledgements page to recognize your efforts on behalf of | ||
the American public, but you are also welcome to submit anonymously. | ||
|
||
Review the HHS Disclosure Policy and websites in scope: | ||
[https://www.hhs.gov/vulnerability-disclosure-policy/index.html](https://www.hhs.gov/vulnerability-disclosure-policy/index.html). | ||
|
||
This policy describes *what systems and types of research* are covered under this | ||
policy, *how to send* us vulnerability reports, and *how long* we ask security | ||
researchers to wait before publicly disclosing vulnerabilities. | ||
|
||
If you have other cybersecurity related questions, please contact us at | ||
[[email protected]](mailto:[email protected]). | ||
|
||
## Public domain | ||
|
||
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/). | ||
|
||
All contributions to this project will be released under the CC0 dedication. By submitting a pull request or issue, you are agreeing to comply with this waiver of copyright interest. |
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,34 @@ | ||
# License | ||
|
||
As a work of the [United States government](https://www.usa.gov/), this project | ||
is in the public domain within the United States of America. | ||
|
||
Additionally, we waive copyright and related rights in the work worldwide | ||
through the CC0 1.0 Universal public domain dedication. | ||
|
||
## CC0 1.0 Universal Summary | ||
|
||
This is a human-readable summary of the [Legal Code (read the full | ||
text)](https://creativecommons.org/publicdomain/zero/1.0/legalcode). | ||
|
||
### No Copyright | ||
|
||
The person who associated a work with this deed has dedicated the work to the | ||
public domain by waiving all of their rights to the work worldwide under | ||
copyright law, including all related and neighboring rights, to the extent | ||
allowed by law. | ||
|
||
You can copy, modify, distribute, and perform the work, even for commercial | ||
purposes, all without asking permission. | ||
|
||
### Other Information | ||
|
||
In no way are the patent or trademark rights of any person affected by CC0, nor | ||
are the rights that other persons may have in the work or in how the work is | ||
used, such as publicity or privacy rights. | ||
|
||
Unless expressly stated otherwise, the person who associated a work with this | ||
deed makes no warranties about the work, and disclaims liability for all uses | ||
of the work, to the fullest extent permitted by applicable law. When using or | ||
citing the work, you should not imply endorsement by the author or the | ||
affirmer. |
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,21 @@ | ||
# Maintainers | ||
|
||
MAINTAINERS: | ||
|
||
- lucasmbrown-usds | ||
- aprilypchen | ||
|
||
approvers: | ||
|
||
- TBA | ||
|
||
reviewers: | ||
|
||
- decause-gov | ||
|
||
| Roles | Responsibilities | Requirements | Defined by | | ||
| --- |:--- |:--- |:--- | | ||
| member | active contributor in the community | multiple contributions to the project. | PROJECT GitHub org Committer Team | | ||
| reviewer | review contributions from other members | history of review and authorship in a subproject | MAINTAINERS file reviewer entry, and GitHub Org Triage Team | | ||
| approver | approve accepting contributions | highly experienced and active reviewer + contributor to a subproject | MAINTAINERS file approver entry and GitHub Triage Team | | ||
| lead | set direction and priorities for a subproject | demonstrated responsibility and excellent technical judgement for the subproject | MAINTAINERS file owner entry and GitHub Org Admin Team | |
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 |
---|---|---|
@@ -1 +1,88 @@ | ||
# grants-api | ||
# Grants.gov modernization | ||
|
||
A modernization effort for Grants.gov. | ||
|
||
## Getting Started | ||
|
||
### Agency Mission | ||
|
||
### Team Mission | ||
|
||
### Project Vision | ||
|
||
### Project Information | ||
<!-- Example Innersource Project Info | ||
* [Project Website](https://cms.gov/digital-service-cms) | ||
* [Project Documentation:](https://confluence.cms.gov/) | ||
* [Project Sprint/Roadmap:](https://jira.cms.gov/) | ||
* [Project Slack Channel:](https://cmsgov.slack.com/archives/XXXXXXXXXX) | ||
* [Project Tools/Hosting/Deployment:](https://confluence.cms.gov) | ||
* Project Keyword(s) for Search: KEYWORD1, KEYWORD2 | ||
* Project Members: | ||
* Team Lead, PO, Delivery Lead, Approvers, Trusted Committers etc. | ||
--> | ||
|
||
<!-- Example Open Source Info | ||
* [Project Website](https://cms.gov/digital-service-cms) | ||
* [Project Documentation:](https://confluence.cms.gov/) | ||
* Public Contact: [email protected] (**NOTE: Do not use individual/personal email addresses**) | ||
* Follow [@CMSgov](https://twitter.com/cmsgov) on Twitter for updates. | ||
--> | ||
|
||
### Installation | ||
|
||
<!--- Example Install Instructions | ||
1. Clone the repo | ||
`git clone https://github.com/cmsgov/PROJECT_REPO.git` | ||
1. Setup your development environment | ||
`python -m venv venv` | ||
1. Install project dependencies | ||
`pip install -r requirements.txt` | ||
`yarn install package.json` | ||
1. Run the test suite | ||
`pytest tests/tox.ini` | ||
1. Start the webserver | ||
`make start` | ||
1. Visit [localhost:9001](https://localhost:9001) to view the server | ||
--> | ||
|
||
### Testing | ||
|
||
## Contributing | ||
|
||
Thank you for considering contributing to an Open Source project of the US | ||
Government! For more information about our contribution guidelines, see | ||
[CONTRIBUTING.md](CONTRIBUTING.md) | ||
|
||
## Security | ||
|
||
For more information about our Security, Vulnerability, and Responsible | ||
Disclosure Policies, see [SECURITY.md](SECURITY.md). | ||
|
||
## Authors and Maintainers | ||
|
||
For more information about our Authors and maintainers, see [MAINTAINERS.md](MAINTAINERS.md). | ||
A full list of [contributors](https://github.com/HHS/grants-api/graphs/contributors?type=a) can be found on GitHub. | ||
|
||
## Public domain | ||
|
||
This project is licensed within in the public domain within the United States, | ||
and copyright and related rights in the work worldwide are waived through the | ||
[CC0 1.0 Universal public domain | ||
dedication](https://creativecommons.org/publicdomain/zero/1.0/). | ||
|
||
All contributions to this project will be released under the CC0 dedication. By | ||
submitting a pull request or issue, you are agreeing to comply with this waiver | ||
of copyright interest. |
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 @@ | ||
# Security and Responsible Disclosure Policy | ||
|
||
*Submit a vulnerability:* Unfortunately, we cannot accept secure submissions via | ||
email or via GitHub Issues. Please use our website to submit vulnerabilities at | ||
[https://hhs.responsibledisclosure.com](https://hhs.responsibledisclosure.com). | ||
HHS maintains an acknowledgements page to recognize your efforts on behalf of | ||
the American public, but you are also welcome to submit anonymously. | ||
|
||
Review the HHS Disclosure Policy and websites in scope: | ||
[https://www.hhs.gov/vulnerability-disclosure-policy/index.html](https://www.hhs.gov/vulnerability-disclosure-policy/index.html). | ||
|
||
This policy describes *what systems and types of research* are covered under this | ||
policy, *how to send* us vulnerability reports, and *how long* we ask security | ||
researchers to wait before publicly disclosing vulnerabilities. | ||
|
||
If you have other cybersecurity related questions, please contact us at | ||
[[email protected].](mailto:[email protected]). |
Oops, something went wrong.