Skip to content

Commit f10eb83

Browse files
committed
doc updates
1 parent 7bd5b34 commit f10eb83

File tree

9 files changed

+717
-225
lines changed

9 files changed

+717
-225
lines changed

AspNetCore.SecurityKey.sln

Lines changed: 0 additions & 79 deletions
This file was deleted.

AspNetCore.SecurityKey.slnx

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<Solution>
2+
<Folder Name="/Build/">
3+
<File Path=".github/workflows/dotnet.yml" />
4+
<File Path="README.md" />
5+
<File Path="src/Directory.Build.props" />
6+
</Folder>
7+
<Folder Name="/Samples/">
8+
<File Path="samples/Directory.Build.props" />
9+
<Project Path="samples/Sample.Controllers/Sample.Controllers.csproj" />
10+
<Project Path="samples/Sample.Middleware/Sample.Middleware.csproj" />
11+
<Project Path="samples/Sample.MinimalApi/Sample.MinimalApi.csproj" />
12+
<Project Path="samples/Sample.Shared/Sample.Shared.csproj" />
13+
</Folder>
14+
<Folder Name="/Tests/">
15+
<File Path="test/Directory.Build.props" />
16+
<Project Path="test/AspNetCore.SecurityKey.Tests/AspNetCore.SecurityKey.Tests.csproj" />
17+
</Folder>
18+
<Project Path="src/AspNetCore.SecurityKey/AspNetCore.SecurityKey.csproj" />
19+
</Solution>

CONTRIBUTING.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Contributing to AspNetCore.SecurityKey
2+
3+
Thank you for considering contributing to AspNetCore.SecurityKey! We welcome contributions from the community.
4+
5+
## How to Contribute
6+
7+
### Reporting Issues
8+
9+
- Use the GitHub issue tracker to report bugs or request features
10+
- Provide clear reproduction steps for bugs
11+
- Include environment information (.NET version, OS, etc.)
12+
13+
### Pull Requests
14+
15+
1. Fork the repository
16+
2. Create a feature branch from `main`
17+
3. Make your changes
18+
4. Add or update tests as needed
19+
5. Ensure all tests pass
20+
6. Update documentation if needed
21+
7. Submit a pull request
22+
23+
### Development Setup
24+
25+
1. Clone the repository:
26+
27+
```bash
28+
git clone https://github.com/loresoft/AspNetCore.SecurityKey.git
29+
```
30+
31+
2. Build the solution:
32+
33+
```bash
34+
dotnet build
35+
```
36+
37+
3. Run tests:
38+
39+
```bash
40+
dotnet test
41+
```
42+
43+
4. Run samples to test your changes:
44+
45+
```bash
46+
cd samples/Sample.MinimalApi
47+
dotnet run
48+
```
49+
50+
### Code Style
51+
52+
- Follow existing code conventions
53+
- Use meaningful variable and method names
54+
- Add XML documentation for public APIs
55+
- Keep methods focused and concise
56+
57+
### Testing
58+
59+
- Write unit tests for new functionality
60+
- Ensure existing tests continue to pass
61+
- Test with the sample applications
62+
63+
## Questions?
64+
65+
Feel free to open an issue for any questions about contributing.

0 commit comments

Comments
 (0)