Skip to content

Commit 8df443b

Browse files
lelialelia
authored
Initial commit
0 parents  commit 8df443b

14 files changed

+535
-0
lines changed

‎.github/ISSUE_TEMPLATE/BUG_REPORT.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## Description
11+
12+
Please provide a description of the problem.
13+
14+
## Expected Behavior
15+
16+
Please describe what you expected would happen.
17+
18+
## Actual Behavior
19+
20+
Please describe what happened instead.
21+
22+
## Affected Version
23+
24+
Please provide the version number where this issue was encountered.
25+
26+
## Steps to Reproduce
27+
28+
1. First step
29+
1. Second step
30+
1. etc.
31+
32+
## Checklist
33+
34+
<!-- TODO: Update the link below to point to your project's contributing guidelines -->
35+
- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md)
36+
- [ ] I have verified this does not duplicate an existing issue

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a feature for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## Problem Statement
11+
12+
Please describe the problem to be addressed by the proposed feature.
13+
14+
## Proposed Solution
15+
16+
Please describe what you envision the solution to this problem would look like.
17+
18+
## Alternatives Considered
19+
20+
Please briefly describe which alternatives, if any, have been considered, including merits of alternate approaches and
21+
tradeoffs being made.
22+
23+
## Additional Context
24+
25+
Please provide any other information that may be relevant.

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Description
2+
3+
Please provide a meaningful description of what this change will do, or is for. Bonus points for including links to
4+
related issues, other PRs, or technical references.
5+
6+
Note that by _not_ including a description, you are asking reviewers to do extra work to understand the context of this
7+
change, which may lead to your PR taking much longer to review, or result in it not being reviewed at all.
8+
9+
## Type of Change
10+
11+
- [ ] Bug Fix
12+
- [ ] New Feature
13+
- [ ] Breaking Change
14+
- [ ] Refactor
15+
- [ ] Documentation
16+
- [ ] Other (please describe)
17+
18+
## Checklist
19+
20+
<!-- TODO: Update the link below to point to your project's contributing guidelines -->
21+
- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md)
22+
- [ ] Existing issues have been referenced (where applicable)
23+
- [ ] I have verified this change is not present in other open pull requests
24+
- [ ] Functionality is documented
25+
- [ ] All code style checks pass
26+
- [ ] New code contribution is covered by automated tests
27+
- [ ] All new and existing tests pass

‎.github/dependabot.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
groups:
6+
github:
7+
patterns:
8+
- "actions/*"
9+
- "github/*"
10+
schedule:
11+
interval: "weekly"

‎.github/workflows/lint.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: lint
2+
3+
on:
4+
push:
5+
branches:
6+
# Run on pushes to default branch
7+
- main
8+
# Run against pull requests
9+
pull_request:
10+
11+
jobs:
12+
markdown:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: 🔒 harden runner
16+
uses: step-security/harden-runner@63c24ba6bd7ba022e95695ff85de572c04a18142 # v2.7.0
17+
with:
18+
egress-policy: audit
19+
- uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # v4.1.2
20+
- name: ⬇️ lint markdown files
21+
uses: avto-dev/markdown-lint@04d43ee9191307b50935a753da3b775ab695eceb # v1.5.0
22+
with:
23+
config: ".markdownlint.json"
24+
args: "**/*.md .github/**/*.md"

‎.github/workflows/scorecard.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: scorecard
2+
3+
on:
4+
push:
5+
branches:
6+
# Run on pushes to default branch
7+
- main
8+
schedule:
9+
# Run weekly on Saturdays
10+
- cron: "30 1 * * 6"
11+
# Run when branch protection rules change
12+
branch_protection_rule:
13+
# Run the workflow manually
14+
workflow_dispatch:
15+
16+
# Declare default permissions as read-only
17+
permissions: read-all
18+
19+
jobs:
20+
run-scorecard:
21+
# Call reusable workflow file
22+
uses: cisco-ospo/.github/.github/workflows/_scorecard.yml@main
23+
permissions:
24+
id-token: write
25+
security-events: write
26+
secrets: inherit
27+
with:
28+
# Publish results of Scorecard analysis
29+
publish-results: true

‎.github/workflows/stale.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: stale
2+
3+
on:
4+
schedule:
5+
# Run weekly on Saturdays
6+
- cron: "30 1 * * 6"
7+
# Run the workflow manually
8+
workflow_dispatch:
9+
10+
# Declare default permissions as read-only
11+
permissions: read-all
12+
13+
jobs:
14+
mark-stale:
15+
# Call reusable workflow file
16+
uses: cisco-ospo/.github/.github/workflows/_stale.yml@main
17+
permissions:
18+
contents: read
19+
issues: write
20+
pull-requests: write
21+
with:
22+
days-until-stale: 60
23+
days-until-close: 7
24+
stale-label: "stale"
25+
exempt-label: "keep"

‎.markdownlint.json

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"default": true,
3+
"MD013": {
4+
"line_length": 10000,
5+
"headings": false,
6+
"code_blocks": false,
7+
"tables": false
8+
},
9+
"MD024": {
10+
"siblings_only": true
11+
},
12+
"MD025": {
13+
"front_matter_title": ""
14+
},
15+
"MD041": false
16+
}

‎CHANGELOG.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### TBA
11+
12+
## [1.0.0] - 2024-02-16
13+
14+
### Added
15+
16+
- Add initial workflow for calling reusable workflow by @lelia in #3
17+
- README: Fix maintainer reference by @GaryPWhite in #1
18+
- .github: Add Scorecard workflow by @lelia in #10
19+
- .github: Add Dependabot configuration by @openclarity-service in #11
20+
- Deprecate Renovate and fix GitHub URL refs by @lelia in #14
21+
- Bump actions/checkout from 3.6.0 to 4.1.1 by @dependabot in #15
22+
23+
[unreleased]: https://github.com/cisco-ospo/oss-template/compare/v1.0.0...HEAD
24+
[1.0.0]: https://github.com/cisco-ospo/oss-template/releases/tag/v1.0.0

‎CODE_OF_CONDUCT.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official email address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
*<conduct@ethicalsource.dev>*.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
126+
at [https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

0 commit comments

Comments
 (0)