Skip to content

Commit 2a17499

Browse files
skyopsaiskyopsai
committed
github and readme updates
1 parent b40300d commit 2a17499

7 files changed

Lines changed: 348 additions & 12 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or issue with an existing skill
4+
title: '[BUG] '
5+
labels: 'bug'
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
11+
<!-- A clear and concise description of the bug -->
12+
13+
## Affected Skill
14+
15+
<!-- Specify which skill is affected -->
16+
17+
**Skill Name:**
18+
**Skill Path:** `skills/<category>/<skill-name>`
19+
20+
## Steps to Reproduce
21+
22+
1.
23+
2.
24+
3.
25+
26+
## Expected Behavior
27+
28+
<!-- What you expected to happen -->
29+
30+
## Actual Behavior
31+
32+
<!-- What actually happened -->
33+
34+
## Error Messages
35+
36+
<!-- If applicable, paste any error messages or logs -->
37+
38+
```
39+
Paste error messages here
40+
```
41+
42+
## Environment
43+
44+
- **OS:** [e.g., macOS, Linux, Windows]
45+
- **Tool Version:** [e.g., semgrep 1.45.0]
46+
- **Skill Version:** [from SKILL.md frontmatter]
47+
48+
## Additional Context
49+
50+
<!-- Add any other context, screenshots, or information about the problem -->
51+
52+
## Possible Solution
53+
54+
<!-- Optional: suggest a fix or reason for the bug -->

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Discussion Forum
4+
url: https://github.com/DevSecAgentKit/SecOpsAgentKit/discussions
5+
about: Ask questions and discuss ideas with the community
6+
- name: Documentation
7+
url: https://github.com/DevSecAgentKit/SecOpsAgentKit/blob/main/CONTRIBUTE.md
8+
about: Read the contribution guidelines and skill development documentation

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new skill or enhancement to existing skills
4+
title: '[FEATURE] '
5+
labels: 'enhancement'
6+
assignees: ''
7+
---
8+
9+
## Feature Type
10+
11+
<!-- Mark the relevant option with an 'x' -->
12+
13+
- [ ] New skill request
14+
- [ ] Enhancement to existing skill
15+
- [ ] New functionality for existing tool
16+
- [ ] Documentation improvement
17+
18+
## Description
19+
20+
<!-- A clear and concise description of the feature or enhancement -->
21+
22+
## Use Case
23+
24+
<!-- Describe the security use case this feature addresses -->
25+
26+
**Problem it solves:**
27+
28+
**Target users:**
29+
30+
**Security context:**
31+
32+
## For New Skill Requests
33+
34+
**Proposed Tool:**
35+
**Tool Repository/Documentation:**
36+
**Category:** [appsec/devsecops/secsdlc/compliance/incident-response/offsec]
37+
**Security Frameworks:** [OWASP/CWE/MITRE-ATT&CK/NIST/etc.]
38+
39+
## For Existing Skill Enhancements
40+
41+
**Skill Name:**
42+
**Skill Path:** `skills/<category>/<skill-name>`
43+
44+
**Proposed Enhancement:**
45+
46+
## Expected Workflow
47+
48+
<!-- Describe how this feature would be used in a typical security workflow -->
49+
50+
1.
51+
2.
52+
3.
53+
54+
## Alternatives Considered
55+
56+
<!-- Describe any alternative solutions or features you've considered -->
57+
58+
## Additional Context
59+
60+
<!-- Add any other context, examples, or screenshots about the feature request -->
61+
62+
## Willingness to Contribute
63+
64+
<!-- Are you willing to contribute this feature? -->
65+
66+
- [ ] I am willing to submit a PR for this feature
67+
- [ ] I can help test this feature
68+
- [ ] I can provide domain expertise/guidance

‎.github/ISSUE_TEMPLATE/skill_submission.md‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
name: Skill Submission
3+
about: Submit a new skill for review (alternative to direct PR)
4+
title: '[SKILL] '
5+
labels: 'skill'
6+
assignees: ''
7+
---
8+
9+
## Skill Information
10+
11+
**Skill Name:**
12+
**Tool/Technology:**
13+
**Category:** [appsec/devsecops/secsdlc/compliance/incident-response/offsec]
14+
15+
## Tool Details
16+
17+
**Official Repository/Documentation:**
18+
**License:**
19+
**Maturity:** [experimental/beta/stable/production-ready]
20+
21+
## Skill Description
22+
23+
<!-- Provide a comprehensive description of what this skill does and when to use it -->
24+
25+
**Primary functionality:**
26+
27+
**Specific use cases:**
28+
1.
29+
2.
30+
3.
31+
32+
**Security context:**
33+
34+
## Security Frameworks
35+
36+
<!-- Which security frameworks does this skill reference? -->
37+
38+
- [ ] OWASP
39+
- [ ] CWE
40+
- [ ] MITRE ATT&CK
41+
- [ ] NIST
42+
- [ ] SOC2
43+
- [ ] PCI-DSS
44+
- [ ] GDPR
45+
- [ ] ISO27001
46+
- [ ] Other:
47+
48+
## Proposed Tags
49+
50+
<!-- List relevant tags for skill discovery -->
51+
52+
[tag1, tag2, tag3, ...]
53+
54+
## Dependencies
55+
56+
**Required tools:**
57+
58+
**Python packages (if any):**
59+
60+
**System requirements:**
61+
62+
## Implementation Status
63+
64+
<!-- Mark your progress with an 'x' -->
65+
66+
- [ ] Skill directory created from template
67+
- [ ] SKILL.md frontmatter completed
68+
- [ ] Core workflows documented
69+
- [ ] Scripts implemented and tested
70+
- [ ] References added (if needed)
71+
- [ ] Assets/templates created (if needed)
72+
- [ ] Security considerations documented
73+
- [ ] Validation script passes
74+
- [ ] README.md updated
75+
- [ ] marketplace.json updated
76+
77+
## Testing Performed
78+
79+
<!-- Describe how you tested this skill -->
80+
81+
**Test scenarios:**
82+
1.
83+
2.
84+
3.
85+
86+
**Results:**
87+
88+
## Related Skills
89+
90+
<!-- Are there any related or complementary skills in the repository? -->
91+
92+
## Additional Notes
93+
94+
<!-- Any additional context or information -->
95+
96+
## Checklist Before Submission
97+
98+
- [ ] Skill follows contribution guidelines in CONTRIBUTE.md
99+
- [ ] No sensitive data or credentials included
100+
- [ ] All bundled scripts are executable and tested
101+
- [ ] Description includes "Use when:" clause with specific use cases
102+
- [ ] Version is 0.1.0 for new skills
103+
- [ ] Ready to submit as PR or need guidance

‎.github/pull_request_template.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
## Description
2+
3+
<!-- Provide a brief description of the changes in this PR -->
4+
5+
## Type of Change
6+
7+
<!-- Mark the relevant option with an 'x' -->
8+
9+
- [ ] New skill
10+
- [ ] Bug fix
11+
- [ ] Documentation update
12+
- [ ] Enhancement to existing skill
13+
- [ ] Infrastructure/tooling improvement
14+
15+
## Checklist
16+
17+
<!-- For new skills, ensure all items are checked before submitting -->
18+
19+
### General Requirements
20+
21+
- [ ] My code follows the style guidelines of this project
22+
- [ ] I have performed a self-review of my own code
23+
- [ ] I have commented my code, particularly in hard-to-understand areas
24+
- [ ] I have made corresponding changes to the documentation
25+
26+
### For New Skills
27+
28+
- [ ] Skill initialized using `./scripts/init_skill.sh` or from `_template/`
29+
- [ ] `SKILL.md` frontmatter has all required fields (name, description, version, maintainer, category, tags, frameworks)
30+
- [ ] Description includes specific "Use when:" clause with use cases
31+
- [ ] Version follows semantic versioning (new skills start at 0.1.0)
32+
- [ ] Category matches skill's primary domain
33+
- [ ] All bundled scripts are tested and executable
34+
- [ ] Security considerations are documented
35+
- [ ] No sensitive data or credentials included
36+
- [ ] Validation passes: `./scripts/validate_skill.py skills/<category>/<skill-name>`
37+
- [ ] **README.md updated** with skill entry under appropriate category section
38+
- [ ] **marketplace.json updated** with skill path under appropriate plugin
39+
40+
### For Documentation Updates
41+
42+
- [ ] Changes are accurate and clear
43+
- [ ] Links are valid and working
44+
- [ ] Formatting is consistent with existing documentation
45+
46+
## Testing Performed
47+
48+
<!-- Describe the testing you performed to verify your changes -->
49+
50+
- [ ] Tested all scripts execute without errors
51+
- [ ] Validated against real security scenarios
52+
- [ ] Ran validation script successfully
53+
54+
## Additional Notes
55+
56+
<!-- Add any additional context, screenshots, or information about the PR here -->
57+
58+
## Related Issues
59+
60+
<!-- Link any related issues here using #issue-number -->
61+
62+
Closes #

‎CONTRIBUTE.md‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,12 +234,34 @@ Before submitting, ensure:
234234
- [ ] References are properly linked from SKILL.md
235235
- [ ] Security considerations are documented
236236
- [ ] No sensitive data or credentials included
237+
- [ ] **README.md has been updated** with your skill entry (see step 3.1 below)
238+
- [ ] **marketplace.json has been updated** with your skill path
239+
240+
#### 3.1. Update README.md
241+
242+
Add your skill to the README.md under the appropriate category section using this format:
243+
244+
```markdown
245+
- **[skill-name](skills/category/skill-name/SKILL.md)** - Brief description of what the tool does | [Tool](https://link-to-tool-repository-or-docs)
246+
```
247+
248+
**Example:**
249+
```markdown
250+
- **[sast-semgrep](skills/appsec/sast-semgrep/SKILL.md)** - Static application security testing using Semgrep for vulnerability detection | [Tool](https://semgrep.dev/docs/)
251+
```
252+
253+
**Format requirements:**
254+
- Skill name links to the SKILL.md file in this repository
255+
- Brief description (one line, ~80-100 characters)
256+
- Tool link points to the official tool repository or documentation (first URL in your SKILL.md frontmatter `references`)
257+
- Maintain alphabetical order within the category section
258+
- Ensure the entry matches your skill's `name` and primary `references[0]` from SKILL.md frontmatter
237259

238260
### 4. Submit Pull Request
239261

240262
```bash
241263
git checkout -b skill/my-skill-name
242-
git add skills/appsec/my-skill-name
264+
git add skills/appsec/my-skill-name README.md .claude-plugin/marketplace.json
243265
git commit -m "Add my-skill-name skill for [brief description]"
244266
git push origin skill/my-skill-name
245267
```

0 commit comments

Comments
 (0)