Skip to content
This repository was archived by the owner on Nov 19, 2025. It is now read-only.

Commit 04871f1

Browse files
authored
CII Best Practices (#123)
Closes: n/a # Goal Observe the Linux Foundation's CII [Best Practices](https://bestpractices.coreinfrastructure.org/en/projects/5405). # Approach 1. Add: 1. a pull-request template 2. security policy
1 parent 7c08c84 commit 04871f1

File tree

2 files changed

+40
-3
lines changed

2 files changed

+40
-3
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,27 @@ Closes: #
44
What problem does this pull request solve? This should be close to the goal of the issue this pull request addresses.
55

66
# Approach
7-
1. Describe the approach you chose to solve the above problem.
8-
2. This will help code reviewers get oriented quickly.
9-
3. It will also document for future maintainers exactly what changed (and why) when this PR was merged.
7+
1. **Describe, in numbered steps, the approach you chose** to solve the above problem.
8+
1. This will help code reviewers get oriented quickly.
9+
2. It will also document for future maintainers exactly what changed (and why) when this PR was merged.
10+
2. **Add specs** that either *reproduce the bug* or *cover the new feature*. In the former's case, *make sure it fails without the fix!*
11+
3. Document any new public methods using standard RDoc syntax, or update the existing RDoc for any modified public methods. As an example, see the RDoc for `Location.find_or_init`:
12+
13+
```ruby
14+
# Finds or initializes the Location with the specified attributes.
15+
#
16+
# @param attr [Hash] the attributes for the Location
17+
# @return [Location] the found or initialized Location
18+
# @example
19+
# Location.find_or_init({ la_id: '1', address1: '1261 W 79th Street' })
20+
def self.find_or_init(attr)
21+
la_id = attr.delete('id') || attr.delete('c')
22+
attr.delete('lat-lon') # delete duplicate key
23+
location = find_by_best_key(la_id: la_id, address1: attr['addr1']) || Location.new(la_id: la_id)
24+
common_keys = location.attributes.keys & attr.keys
25+
common_keys.each { |key| location[key] = attr[key] }
26+
location
27+
end
28+
```
29+
30+
Signed-off-by: YOUR NAME <[email protected]>

SECURITY.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
[Dependabot](https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates) automatically [patches known vulnerabilities](https://github.com/FoveaCentral/vaccinesignup/pulls?q=is%3Apr+is%3Aclosed+author%3Aapp%2Fdependabot).
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| 1.0.5 | :white_check_mark: |
10+
| < 1.0.5 | :x: |
11+
12+
## Reporting a Vulnerability
13+
14+
1. To report a security vulnerability, [open an issue](https://github.com/FoveaCentral/vaccinesignup/issues/new/choose).
15+
2. Updates are made within 48 hours.
16+
3. If the vulnerability is accepted, we'll try to patch it within a week.

0 commit comments

Comments
 (0)