Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Issue #4] Set up repo #11

Merged
merged 3 commits into from
Dec 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Bug Report
description: Report a bug
type: Bug
body:
- type: textarea
id: summary
attributes:
label: Summary
description: Please describe the bug you experienced
placeholder: What happened? What did you want to happen?
validations:
required: true
- type: dropdown
id: reproducibility
attributes:
label: Reproducibility
description: Please describe the frequency of the bug
options:
- It happened once then I did not try again
- It happened once then I tried again and everything worked
- I tried multiple times and saw the bug intermittently
- I tried multiple times and saw the bug every time
- None of the above
- type: textarea
id: repro_steps
attributes:
label: How to reproduce the bug
description: To see the bug with our own eyes, what steps should we follow?
validations:
required: false
- type: dropdown
id: browser
attributes:
label: Browser
description: Which web browser were you using when you experienced the bug? (if any)
options:
- Chrome
- Firefox
- Internet Explorer
- Microsoft Edge
- Safari
- Other
- I do not know
- Not applicable
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/HHS/simpler-grants-protocol/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Feature Request
description: Request a new feature
type: Enhancement
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out a feature request!

- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
validations:
required: false

- type: textarea
id: problem_statement
attributes:
label: Is your feature request related to a problem? Please describe
description: A clear and concise description of what the problem is.
validations:
required: false

- type: textarea
id: desired_behavior
attributes:
label: A clear and concise description of what you want to happen
description: Help us understand your improvement ideas.
validations:
required: true

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/HHS/simpler-grants-protocol/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/3-internal-decision.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Internal - Decision
description: Describe a decision that needs to be made and recorded
type: Task
title: "ADR: "
labels: ["adr"]
body:
- type: markdown
attributes:
value: |
Describe an architectural decision that needs to be recorded

- type: markdown
attributes:
value: |
**Example** [Website language and framework](https://github.com/HHS/simpler-grants-protocol/issues/8)

- type: textarea
id: summary
attributes:
label: Summary
description: 1-2 sentence summary of the decision that needs to be made
validations:
required: true

- type: textarea
id: options
attributes:
label: Options
description: List of options to evaluate
validations:
required: false

- type: textarea
id: decision_criteria
attributes:
label: Decision Criteria
description: List of decision criteria to evaluate
validations:
required: false

- type: textarea
id: approvers
attributes:
label: Approvers
description: List individuals or groups that must approve this decision before the ADR is accepted
validations:
required: false

- type: checkboxes
id: acceptance_criteria
attributes:
label: Acceptance criteria
description: Leave the following acceptance criteria unchecked when the ticket is created then mark them as completed as you meet each criterion with the ADR
options:
- label: The approvers for this decision have been identified (ideally before work on the ADR starts)
- label: The ADR has been reviewed and approved by the approvers listed above
- label: The ADR satisfies requirements that are outlined in the ADR template
- label: Any follow-up tickets have been created (if necessary)
validations:
required: false
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/4-internal-task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Internal - Task
description: Describe a task that needs to be completed
type: Task
body:
- type: textarea
id: summary
attributes:
label: Summary
description: A clear and concise summary of the task
validations:
required: true

- type: textarea
id: acceptance_criteria
attributes:
label: Acceptance criteria
description: What conditions must be satisfied to consider this task done?
validations:
required: true
13 changes: 13 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### Summary

- Fixes #[issue number]
- Time to review: [xx] minutes

### Changes proposed
> What was added, updated, or removed in this PR.

### Context for reviewers
> Testing instructions, background context, more in-depth details of the implementation, and anything else you'd like to call out or ask reviewers. Explain how the changes were verified.

### Additional information
> Screenshots, GIF demos, code examples or output to help show the changes working as expected.
13 changes: 13 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for everyone, regardless of the level of experience, gender, gender identity, expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.

Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the Contributor Covenant version 1.0.0, available at http://contributor-covenant.org/version/1/0/0 .
36 changes: 36 additions & 0 deletions COMMUNITY_GUIDELINES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Community Organization and Governance

The grants.gov team is taking a community-first and open source approach to the product development of this tool. We believe government software should be made in the open and be built and licensed such that anyone can download the code, run it themselves without paying money to third parties or using proprietary software, and use it as they will.

We know that we can learn from a wide variety of communities, including those who will use or will be impacted by the tool, who are experts in technology, or who have experience with similar technologies deployed in other spaces. We are dedicated to creating forums for continuous conversation and feedback to help shape the design and development of the tool.

We also recognize capacity building as a key part of involving a diverse open source community. We are doing our best to use accessible language, provide technical and process documents in multiple languages, and offer support to community members with a wide variety of backgrounds and skillsets. If you have ideas for how we can improve or add to our capacity building efforts and methods for welcoming people into our community, please let us know by filing an issue on our GitHub repository.

## Principles

Principles and guidelines for participating in our open source community are linked below here. Please read them before joining or starting a conversation in this repo or one of the channels listed below. All community members and participants are expected to adhere to the community guidelines and code of conduct when participating in community spaces including: code repositories, communication channels and venues, and events.

These principles guide our data, product, and process decisions, architecture, and approach. These guidelines are inspired by the [Justice40 Community Guidelines](https://github.com/usds/justice40-tool/blob/main/COMMUNITY_GUIDELINES.md).

- Open means transparent and participatory.
- We take a modular and modern approach to software development.
- We build open-source software and open-source processes.
- We value ease of implementation.
- Fostering community includes building capacity and making our software and processes accessible to participants with diverse backgrounds and skillsets.
- Data (and data science) is as important as software and process. We build open data sets where possible.
- We strive for transparency for algorithms and places we might be introducing bias.

All community members are expected to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md).

## Community Guidelines

- When participating in the Simpler Grants open source community conversations and spaces, we ask individuals to follow the following guidelines:
- When joining a conversation for the first time, please introduce yourself by providing a brief intro that includes:
- your related organization (if applicable)
- your pronouns, if you would like to share those
- disclosure of any current or potential financial interest in this work
- your superpower, and how you hope to use it for this project
- Embrace a culture of learning, and educate each other. We are all entering this conversation from different starting points and with different backgrounds. There are no dumb questions.
- Take space and give space. We strive to create an equitable environment in which all are welcome and able to participate. We hope individuals feel comfortable voicing their opinions and providing contributions and will do our best to recognize and make space for individuals who may be struggling to find space here. Likewise, we expect individuals to recognize when they are taking up significant space and take a step back to allow room for others.
- Be present when joining synchronous conversations such as our community chat. Why be here if you're not going to be here?
- Be respectful.
46 changes: 46 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributing Guidelines

🎉 First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to this repository.

Before contributing, we encourage you to also read our [LICENSE](LICENSE.md) and [README](README.md) files, also found in this repository. If you have any questions not answered by the content of this repository, please don't hesitate to post in the discussions thread.

## How Can I Contribute?

### Report a bug

If you think you have found a bug in this tool, we'd love your help identifying and fixing it. To do so, please follow these guidelines:

1. **Search the issue list:** Check to see if anyone has reported a similar issue. If so, comment on that issue with additional details or context.
2. **Use the issue template** If no one else has reported it yet, please submit a new issue and select the [bug report template](https://github.com/HHS/simpler-grants-protocol/issues/new?template=1-bug-report.yml).
3. **Check the Bug Tracker:** Check the status of your bug by referencing the Bug Tracker project board on the project tab.

### Request new functionality

If you don't have specific language or code to submit but would like to suggest a change, request a feature,
or have something addressed, we'd love to get your feedback. To request new functionality, please follow these guidelines:

1. **Search the issue list:** Check the list of existing issues to see if anyone has requested a similar feature or functionality. If so, feel free to comment on that issue with more context or details.
2. **Use the issue template** If no one else has requested something similar, please submit a new issue and select the [Feature Request](https://github.com/HHS/simpler-grants-protocol/issues/new?template=2-feature-request.yml) template.

> **NOTE:** Not all feature requests will be implemented. The project maintainers will review each feature request and consider scoping it into the roadmap or explain why the feature won't be implemented.

### Contribute to the codebase

If you've implemented a new feature, fixed a bug, or made some documentation clearer, we'd love to consider your contribution to this tool. In order to submit a contribution, please follow these steps:

1. **Fork the repo:** Create a copy of this repo where you can make your proposed changes by [following the Github forking methodology](https://docs.github.com/en/github/getting-started-with-github/quickstart/fork-a-repo).
1. **Find or create an issue:** Before proposing a change, make sure there is a corresponding issue (i.e. Bug Fix, Task, Feature Request) that describes the contribution you'll be making. If there isn't an existing issue, create a new one by selecting and filling out a template from the issue tab.
1. **Create a feature branch:** Create a feature branch on your forked repository with a descriptive name, ideally one that references the issue number that your contribution is related to (e.g., `issue-10-unit-testing`).
1. **Make changes and test them:** Add your code or documentation and commit those changes to the feature branch. If your contribution includes code, make sure you've written tests for it and that all of the tests are passing.
1. **Submit a pull request** When you're ready to make your contribution, [submit a pull request against the upstream repo.](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) and fill out the PR template sections so that project maintainers can begin to review your contributions.
1. **Fix requested changes:** As maintainers review your proposed contribution, they may request specific changes. If so, simply add and commit those changes to the feature branch directly and they'll automatically show up on the PR.
1. **Celebrate:** Once all of the requested changes are made, your commits will be merged into the `main` branch. Time to give yourself a hand because you just added to this project!!!

## Resources

To learn more about contributing best practices or how to use GitHub for code collaboration, don't hesitate to check these resources out:

- [GitHub Tutorials](https://lab.github.com/)
- [How to contribute to open source software](https://opensource.guide/how-to-contribute/)
34 changes: 34 additions & 0 deletions LICENSE.md
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.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
# simpler-grants-protocol
# Simpler Grants Protocol

A common standard for sharing grants data.
17 changes: 17 additions & 0 deletions SECURITY.md
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
[csirc@hhs.gov.](mailto:csirc@hhs.gov).