Skip to content

Commit 884d7ad

Browse files
CopilotMalcolmnixon
andcommitted
Fix references to Template DotNet Tool in documentation files
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
1 parent 2fdd9d1 commit 884d7ad

File tree

4 files changed

+26
-26
lines changed

4 files changed

+26
-26
lines changed

.yamllint.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
# yamllint configuration for SarifMark
2+
# yamllint configuration for Template DotNet Tool
33
# This configuration defines the rules for YAML file linting
44

55
extends: default

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,4 +131,4 @@ For answers to common questions about this code of conduct, see the FAQ at
131131
[Mozilla CoC]: https://github.com/mozilla/diversity
132132
[FAQ]: https://www.contributor-covenant.org/faq
133133
[translations]: https://www.contributor-covenant.org/translations
134-
[issues]: https://github.com/demaconsulting/SarifMark/issues
134+
[issues]: https://github.com/demaconsulting/TemplateDotNetTool/issues

CONTRIBUTING.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to SarifMark
1+
# Contributing to Template DotNet Tool
22

3-
Thank you for your interest in contributing to SarifMark! We welcome contributions from the community and appreciate
3+
Thank you for your interest in contributing to Template DotNet Tool! We welcome contributions from the community and appreciate
44
your help in making this project better.
55

66
## Code of Conduct
@@ -18,7 +18,7 @@ If you find a bug, please create an issue on GitHub with the following informati
1818
- **Steps to Reproduce**: Detailed steps to reproduce the issue
1919
- **Expected Behavior**: What you expected to happen
2020
- **Actual Behavior**: What actually happened
21-
- **Environment**: Operating system, .NET version, SarifMark version
21+
- **Environment**: Operating system, .NET version, Template DotNet Tool version
2222
- **Logs**: Any relevant error messages or logs
2323

2424
### Suggesting Features
@@ -56,8 +56,8 @@ We follow a standard GitHub workflow for contributions:
5656
1. Clone the repository:
5757

5858
```bash
59-
git clone https://github.com/demaconsulting/SarifMark.git
60-
cd SarifMark
59+
git clone https://github.com/demaconsulting/TemplateDotNetTool.git
60+
cd Template DotNet Tool
6161
```
6262

6363
2. Restore dependencies:
@@ -253,7 +253,7 @@ When creating a pull request, include:
253253

254254
## Requirements Management
255255

256-
SarifMark uses [DemaConsulting.ReqStream][reqstream] for requirements traceability:
256+
Template DotNet Tool uses [DemaConsulting.ReqStream][reqstream] for requirements traceability:
257257

258258
- All requirements are defined in `requirements.yaml`
259259
- Each requirement should be linked to test cases
@@ -278,14 +278,14 @@ Releases are managed by project maintainers. The process includes:
278278

279279
## License
280280

281-
By contributing to SarifMark, you agree that your contributions will be licensed under the MIT License.
281+
By contributing to Template DotNet Tool, you agree that your contributions will be licensed under the MIT License.
282282

283-
Thank you for contributing to SarifMark!
283+
Thank you for contributing to Template DotNet Tool!
284284

285-
[code-of-conduct]: https://github.com/demaconsulting/SarifMark/blob/main/CODE_OF_CONDUCT.md
285+
[code-of-conduct]: https://github.com/demaconsulting/TemplateDotNetTool/blob/main/CODE_OF_CONDUCT.md
286286
[dotnet-download]: https://dotnet.microsoft.com/download
287287
[csharp-conventions]: https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions
288288
[reqstream]: https://github.com/demaconsulting/ReqStream
289-
[discussions]: https://github.com/demaconsulting/SarifMark/discussions
290-
[issues]: https://github.com/demaconsulting/SarifMark/issues
291-
[security]: https://github.com/demaconsulting/SarifMark/blob/main/SECURITY.md
289+
[discussions]: https://github.com/demaconsulting/TemplateDotNetTool/discussions
290+
[issues]: https://github.com/demaconsulting/TemplateDotNetTool/issues
291+
[security]: https://github.com/demaconsulting/TemplateDotNetTool/blob/main/SECURITY.md

SECURITY.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ We release patches for security vulnerabilities in the following versions:
1111

1212
## Reporting a Vulnerability
1313

14-
We take the security of SarifMark seriously. If you believe you have found a security vulnerability, please report it
14+
We take the security of Template DotNet Tool seriously. If you believe you have found a security vulnerability, please report it
1515
to us as described below.
1616

1717
### How to Report
@@ -60,31 +60,31 @@ Security updates will be released as:
6060

6161
## Security Best Practices
6262

63-
When using SarifMark, we recommend following these security best practices:
63+
When using Template DotNet Tool, we recommend following these security best practices:
6464

6565
### Input Validation
6666

6767
- Validate SARIF analysis tools API responses before processing
6868
- Be cautious when processing data from untrusted sources
69-
- Use the latest version of SarifMark to benefit from security updates
69+
- Use the latest version of Template DotNet Tool to benefit from security updates
7070

7171
### Dependencies
7272

73-
- Keep SarifMark and its dependencies up to date
73+
- Keep Template DotNet Tool and its dependencies up to date
7474
- Review the release notes for security-related updates
7575
- Use `dotnet list package --vulnerable` to check for vulnerable dependencies
7676

7777
### Execution Environment
7878

79-
- Run SarifMark with the minimum required permissions
80-
- Avoid running SarifMark as a privileged user unless necessary
79+
- Run Template DotNet Tool with the minimum required permissions
80+
- Avoid running Template DotNet Tool as a privileged user unless necessary
8181
- Validate API tokens and credentials are stored securely
8282

8383
## Known Security Considerations
8484

8585
### API Integration
8686

87-
SarifMark integrates with SARIF analysis tools APIs. Users should:
87+
Template DotNet Tool integrates with SARIF analysis tools APIs. Users should:
8888

8989
- Protect API tokens and credentials
9090
- Use HTTPS connections to SARIF analysis tools
@@ -93,7 +93,7 @@ SarifMark integrates with SARIF analysis tools APIs. Users should:
9393

9494
### File System Access
9595

96-
SarifMark reads and writes files on the local file system. Users should:
96+
Template DotNet Tool reads and writes files on the local file system. Users should:
9797

9898
- Ensure appropriate file permissions are set on output files
9999
- Be cautious when processing files in shared directories
@@ -116,7 +116,7 @@ We will credit security researchers who report vulnerabilities responsibly. If y
116116

117117
## Third-Party Dependencies
118118

119-
SarifMark relies on third-party packages. We:
119+
Template DotNet Tool relies on third-party packages. We:
120120

121121
- Regularly update dependencies to address known vulnerabilities
122122
- Use Dependabot to monitor for security updates
@@ -141,9 +141,9 @@ For general bugs and feature requests, please use [GitHub Issues][issues].
141141
- [.NET Security Best Practices][dotnet-security]
142142
- [GitHub Security Advisories][security-advisories]
143143

144-
Thank you for helping keep SarifMark and its users safe!
144+
Thank you for helping keep Template DotNet Tool and its users safe!
145145

146-
[security-advisories]: https://github.com/demaconsulting/SarifMark/security/advisories
147-
[issues]: https://github.com/demaconsulting/SarifMark/issues
146+
[security-advisories]: https://github.com/demaconsulting/TemplateDotNetTool/security/advisories
147+
[issues]: https://github.com/demaconsulting/TemplateDotNetTool/issues
148148
[owasp-practices]: https://owasp.org/www-project-secure-coding-practices-quick-reference-guide/
149149
[dotnet-security]: https://learn.microsoft.com/en-us/dotnet/standard/security/

0 commit comments

Comments
 (0)