Skip to content

Commit 1d28dcd

Browse files
detiliumdetilium
authored
v1.2.0
1 parent 534efa7 commit 1d28dcd

29 files changed

Lines changed: 1057 additions & 124 deletions

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Bug
2+
description: Report a bug in the system
3+
title: "[Bug]: <title>"
4+
labels: bug
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Description
9+
description: A clear and concise description of the bug.
10+
validations:
11+
required: true
12+
- type: textarea
13+
attributes:
14+
label: Expected behavior
15+
description: Explain what you expected to happen.
16+
validations:
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Steps to reproduce
21+
description: Steps the reproduce the behavior.
22+
placeholder: |
23+
1. Setup ...
24+
2. Call function ...
25+
3. See exception ...
26+
validations:
27+
required: false
28+
- type: textarea
29+
attributes:
30+
label: Environment
31+
description: |
32+
examples:
33+
- **NET version**: .NET 9
34+
- **OS**: Windows 11
35+
- **Version**: v1.0.1
36+
render: markdown
37+
validations:
38+
required: false
39+
- type: textarea
40+
attributes:
41+
label: Additional context
42+
description: Add any other context about the problem here.
43+
validations:
44+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Documentation
2+
description: Suggest updates or additions to documentation
3+
title: "[Docs]: <title>"
4+
labels: docs
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Documentation update
9+
description: What part of the documentation needs to be updated or added?
10+
validations:
11+
required: true
12+
- type: textarea
13+
attributes:
14+
label: Why is this needed?
15+
description: Explain the importance of this update.
16+
validations:
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Suggested changes
21+
description: Provide a detailed description of the changes.
22+
validations:
23+
required: true
24+
- type: textarea
25+
attributes:
26+
label: Additional context
27+
description: Add any other context about the problem here.
28+
validations:
29+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Feature request
2+
description: Suggest a new feature or improvement
3+
title: "[Feature]: <title>"
4+
labels: enhancement
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Feature description
9+
description: What feature would you like to see?
10+
validations:
11+
required: true
12+
- type: textarea
13+
attributes:
14+
label: Why is this needed?
15+
description: Explain the problem or need for this feature.
16+
validations:
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Suggested solutions
21+
description: Describe how this feature could be implemented.
22+
validations:
23+
required: false
24+
- type: textarea
25+
attributes:
26+
label: Additional context
27+
description: Add any other context about the problem here.
28+
validations:
29+
required: false

‎.github/ISSUE_TEMPLATE/general_report.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: General report
2+
description: Provide general feedback or inquiries
3+
title: "[General]: <title>"
4+
labels: general
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Feedback or inquiry
9+
description: Provide your feedback or inquiry.
10+
validations:
11+
required: true
12+
- type: textarea
13+
attributes:
14+
label: Additional context
15+
description: Add any other context about the problem here.
16+
validations:
17+
required: false

‎.github/workflows/ci.yml‎

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
name: Continout Integration
1+
name: Continous Integration
22

33
on:
44
push:
5-
branches: [ "dev", "master" ]
5+
branches: ["dev", "master"]
66
pull_request:
7-
branches: [ "dev", "master" ]
7+
branches: ["dev", "master"]
88

99
env:
1010
CI_BUILD_NUMBER_BASE: ${{ github.run_number }}
@@ -13,29 +13,28 @@ env:
1313

1414
jobs:
1515
build:
16-
1716
# We need to run on Windows as we're supporting .NET Framework
1817
runs-on: windows-latest
1918

2019
permissions:
2120
contents: write
2221

2322
steps:
24-
- uses: actions/checkout@v5
25-
- name: Setup .NET
26-
uses: actions/setup-dotnet@v5
27-
with:
28-
dotnet-version: 10.0.x
29-
- name: Compute and set build number
30-
shell: bash
31-
run: |
23+
- uses: actions/checkout@v5
24+
- name: Setup .NET
25+
uses: actions/setup-dotnet@v5
26+
with:
27+
dotnet-version: 10.0.x
28+
- name: Compute and set build number
29+
shell: bash
30+
run: |
3231
echo "CI_BUILD_NUMBER=$(($CI_BUILD_NUMBER_BASE+1000))" >> $GITHUB_ENV
33-
- name: Build & Push
34-
env:
35-
PR_TRIGGER: ${{ env.PR_TRIGGER }}
36-
DOTNET_CLI_TELEMTRY_OPTOUT: true
37-
NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}
38-
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
39-
shell: pwsh
40-
run: |
41-
./Build.ps1
32+
- name: Build & Push
33+
env:
34+
PR_TRIGGER: ${{ env.PR_TRIGGER }}
35+
DOTNET_CLI_TELEMTRY_OPTOUT: true
36+
NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}
37+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
38+
shell: pwsh
39+
run: |
40+
./Build.ps1

‎ByteGuard.FileValidator.slnx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
<File Path="Directory.Version.props" />
66
<File Path="LICENSE" />
77
<File Path="README.md" />
8+
<File Path="SECURITY.md" />
89
</Folder>
910
<Folder Name="/tests/">
1011
<Project Path="tests/ByteGuard.FileValidator.Tests.Unit/ByteGuard.FileValidator.Tests.Unit.csproj" />

‎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+
byteguard-hq@proton.me.
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: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Contributing to ByteGuard
2+
3+
Thanks for considering contributing to ByteGuard.
4+
5+
ByteGuard is an open-source initiative focused on practical application-security tooling. Contributions like bug reports, PRs, docs, tests, and feedback help keep the ecosystem useful and trustworthy.
6+
7+
These are lightweight guidelines for contributing to ByteGuard repositories hosted under the ByteGuard organization. This is a living document — improvements via PR are welcome.
8+
9+
## Where to start?
10+
11+
Each repository is the best place to contribute to its own scope:
12+
13+
- **Core libraries/packages**: changes and fixes belong in the relevant package repo.
14+
- **Docs and examples**: improvements are always welcome (especially clarity and real-world usage).
15+
16+
If you’re new, look for issues labeled **good first issue**, **up-for-grabs**, or **help wanted** (if the repo uses them).
17+
18+
Before starting work on a PR, consider commenting on an existing issue or creating one so we can align on approach.
19+
20+
## Reporting an issue
21+
22+
Bugs and enhancements are tracked via GitHub Issues.
23+
24+
When creating an issue, please include:
25+
26+
- What you expected vs. what happened
27+
- Steps to reproduce (a minimal sample helps a lot)
28+
- Version(s) affected
29+
- Environment details (OS/runtime/framework, where relevant)
30+
- Logs/error output (please **redact secrets**)
31+
32+
## Requesting a feature/enhancement
33+
34+
Feature requests are also tracked via GitHub Issues.
35+
36+
Please include:
37+
38+
- The problem you’re trying to solve (use-case)
39+
- Your proposed solution (API/behavior, if relevant)
40+
- Alternatives you considered
41+
- Any security implications or compatibility concerns
42+
43+
## Security vulnerabilities
44+
45+
**Please do not open public issues for security vulnerabilities.**
46+
47+
If the repo has **Security Advisories** enabled, report it there. Otherwise, use the security contact information listed in the repository (README/profile) if available.
48+
49+
Include:
50+
51+
- Description + impact
52+
- Affected versions
53+
- Repro steps / PoC (if safe to share)
54+
- Suggested mitigation (if you have one)
55+
56+
## Making a PR
57+
58+
- If an issue does not already exist, please create one first (or explain the motivation clearly in the PR).
59+
- Fork the repository and create a branch with a descriptive name.
60+
- Keep commits as logical units and reference the related issue when possible.
61+
- Run build/tests locally before opening the PR.
62+
- Prefer small, focused PRs over large multi-purpose changes.
63+
- For behavior changes or fixes, tests are strongly encouraged.
64+
65+
## Questions?
66+
67+
ByteGuard has an active and helpful community who are happy to help point you in the right direction or work through any issues you might encounter. You can get in touch via:
68+
69+
- Our [issue tracker](https://github.com/ByteGuard-HQ/byteguard-file-validator-net/issues)
70+
- Our [Discord server](https://discord.com/invite/XwjdR2jmVZ)
71+
72+
Finally, when contributing please keep in mind our [Code of Conduct](CODE_OF_CONDUCT.md).

0 commit comments

Comments
 (0)