Skip to content

Commit 2f03945

Browse files
Magic-Man-usMagic-Man-us
committed
chore: merge remote changes with comprehensive implementation
2 parents c33e3b6 + 3c67bda commit 2f03945

File tree

7 files changed

+339
-79
lines changed

7 files changed

+339
-79
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/pull_request_template.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
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+
- [ ] Bug fix (non-breaking change which fixes an issue)
10+
- [ ] New feature (non-breaking change which adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] Documentation update
13+
- [ ] Code refactoring
14+
- [ ] Performance improvement
15+
- [ ] Test coverage improvement
16+
- [ ] CI/CD or build process change
17+
18+
## Related Issue
19+
20+
<!-- Link to the issue this PR addresses, if applicable -->
21+
<!-- Use "Fixes #123", "Closes #123", or "Related to #123" as appropriate -->
22+
23+
Fixes #(issue number)
24+
25+
## Changes Made
26+
27+
<!-- List the specific changes made in this PR -->
28+
29+
- [Brief description of change 1]
30+
- [Brief description of change 2]
31+
- [Brief description of change 3]
32+
33+
## Testing
34+
35+
<!-- Describe the tests you ran to verify your changes -->
36+
37+
- [ ] Existing tests pass (`make test`)
38+
- [ ] New tests added for new functionality
39+
- [ ] Manual testing performed
40+
41+
### Test Configuration
42+
43+
- Python version:
44+
- Operating system:
45+
46+
## Checklist
47+
48+
<!-- Mark completed items with an "x" -->
49+
50+
- [ ] My code follows the style guidelines of this project
51+
- [ ] I have run `make lint` and addressed any issues
52+
- [ ] I have run `make type` and addressed any issues
53+
- [ ] I have performed a self-review of my own code
54+
- [ ] I have commented my code, particularly in hard-to-understand areas
55+
- [ ] I have made corresponding changes to the documentation
56+
- [ ] My changes generate no new warnings
57+
- [ ] I have added tests that prove my fix is effective or that my feature works
58+
- [ ] New and existing unit tests pass locally with my changes
59+
- [ ] I have run `make precommit` and all pre-commit hooks pass
60+
- [ ] Any dependent changes have been merged and published
61+
62+
## Screenshots (if applicable)
63+
64+
<!-- Add screenshots to help explain your changes, if applicable -->
65+
66+
## Additional Notes
67+
68+
<!-- Add any additional information that reviewers should know -->

‎CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
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, 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 e-mail 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+
deleterious420@gmail.com.
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.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing
2+
3+
Thank you for helping improve SecSuite! This short guide gets you up and running quickly.
4+
5+
Developer quick-start
6+
---------------------
7+
8+
1. Install `uv` (if you don't have it). Follow platform-specific instructions at https://docs.astral.sh/uv/.
9+
10+
2. Sync the development environment and install dev dependencies:
11+
12+
```bash
13+
make install
14+
```
15+
16+
3. Common tasks
17+
18+
- Run tests: `make test` or `./scripts/dev pytest`
19+
- Run lint: `make lint` or `./scripts/dev ruff check .`
20+
- Type check: `make type` or `./scripts/dev mypy src`
21+
- Build docs: `make docs` or `./scripts/dev sphinx-build -b html docs docs/_build`
22+
23+
Pre-commit
24+
----------
25+
26+
Install pre-commit hooks locally:
27+
28+
```bash
29+
make precommit
30+
```
31+
32+
Branching and PRs
33+
------------------
34+
35+
- Create a branch for your feature/fix: `git checkout -b feature/thing`
36+
- Run tests and linters locally before opening a PR.
37+
- Open a PR against `main` and include a short description of the change and why.
38+
39+
Thank you! Keep changes small and focused and include tests for new behavior.

‎SECURITY.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
We provide security updates for specific maintained versions of SecSuite. If your version is not listed below, it is no longer supported and may not receive security fixes.
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| main | :white_check_mark: |
10+
| 1.x | :x: |
11+
12+
## Reporting a Vulnerability
13+
14+
If you discover a potential security vulnerability in SecSuite, please report it privately to our security team so we can investigate and coordinate a fix before public disclosure.
15+
16+
Preferred reporting methods:
17+
18+
- Email: deleterious420@gmail.com
19+
- GitHub: Open a private security advisory in this repository
20+
21+
When reporting, please include:
22+
23+
- A clear and concise description of the vulnerability.
24+
- Steps to reproduce the issue (proof-of-concept) or a small test case.
25+
- Impact assessment (what could an attacker do).
26+
- Any mitigations you've tried or temporary workarounds.
27+
- Your contact information for follow-up.
28+
29+
We will acknowledge receipt within 3 business days and provide a status update within 7 calendar days. If the report requires more time, we'll provide periodic updates until resolved.
30+
31+
## Disclosure and Fix Process
32+
33+
- Triage: We'll verify the report and determine severity.
34+
- Fix: We'll create a fix branch and include tests where appropriate.
35+
- Coordinated Disclosure: We'll work with you to coordinate a disclosure timeline and release a patched version.
36+
- Public Advisory: After release, we'll publish details of the vulnerability and the fix in a public advisory.
37+
38+
## Policy on Public Disclosure
39+
40+
We ask that reporters do not publicly disclose vulnerabilities until a fix is released or we agree on a disclosure timeline.
41+
42+
If you believe the vulnerability is being actively exploited or poses an immediate threat, indicate this in your report and we will prioritize accordingly.
43+
44+
## Thank you
45+
46+
Thank you for helping us keep SecSuite secure. We appreciate responsible disclosure and will credit reporters who request acknowledgment.

0 commit comments

Comments
 (0)