Skip to content

Commit 5297eda

Browse files
authored
docs: Revise docs now that we have a wiki (#235)
* docs: Revise docs now that we have a wiki * docs: Add wiki as a submodule
1 parent 346cfbb commit 5297eda

4 files changed

Lines changed: 46 additions & 926 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 9 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,103 +1,21 @@
11
# Contributing to Azure Event Grid Simulator
22

3-
Thank you for your interest in contributing to Azure Event Grid Simulator! This document provides guidelines and information for contributors.
3+
Thank you for your interest in contributing! This simulator is intended for **local development and testing only**.
44

5-
> **Note:** This simulator is intended for **local development and testing only**. When contributing, keep in mind that features should support local development scenarios, not production use cases.
5+
## Quick Start
66

7-
## Getting Started
7+
1. **Prerequisites:** .NET 10.0 SDK (multi-targets 8.0, 9.0, 10.0)
8+
2. **Build:** `dotnet build src/AzureEventGridSimulator.sln`
9+
3. **Test:** `dotnet test src/AzureEventGridSimulator.sln`
10+
4. **Format:** Code is auto-formatted with [CSharpier](https://csharpier.com/) on build
811

9-
### Prerequisites
12+
## Documentation
1013

11-
- .NET 10.0 SDK (required by global.json to build)
12-
- Git
13-
- Your favorite IDE (Visual Studio, VS Code, Rider, etc.)
14-
15-
> **Note:** While .NET 10.0 SDK is required to build, the project multi-targets .NET 8.0, 9.0, and 10.0 to support users on any of these runtimes.
16-
17-
### Setting Up the Development Environment
18-
19-
1. Fork the repository
20-
2. Clone your fork:
21-
```bash
22-
git clone https://github.com/YOUR_USERNAME/AzureEventGridSimulator.git
23-
cd AzureEventGridSimulator
24-
```
25-
3. Restore dependencies:
26-
```bash
27-
dotnet restore src/AzureEventGridSimulator.sln
28-
```
29-
4. Build the project:
30-
```bash
31-
dotnet build src/AzureEventGridSimulator.sln
32-
```
33-
5. Run tests:
34-
```bash
35-
dotnet test src/AzureEventGridSimulator.sln
36-
```
37-
Git hooks are configured automatically on first build to validate commit messages follow conventional commit format.
38-
39-
## Code Style
40-
41-
This project uses [CSharpier](https://csharpier.com/) for code formatting. CSharpier runs automatically on every build, so your code will be formatted before compilation.
42-
43-
To manually format the code:
44-
```bash
45-
dotnet tool restore
46-
dotnet csharpier format src
47-
```
48-
49-
## Making Changes
50-
51-
### Branch Naming
52-
53-
Create a descriptive branch name for your changes:
54-
- `feature/add-new-subscriber-type`
55-
- `fix/validation-error-handling`
56-
- `docs/update-readme`
57-
58-
### Commit Messages
59-
60-
This project uses [Conventional Commits](https://www.conventionalcommits.org/). Please format your commit messages as:
61-
62-
- `feat:` - A new feature
63-
- `fix:` - A bug fix
64-
- `docs:` - Documentation changes
65-
- `chore:` - Maintenance tasks
66-
- `refactor:` - Code refactoring
67-
- `test:` - Adding or updating tests
68-
69-
Example: `feat: add Azure Storage Queue subscriber support`
70-
71-
### Pull Requests
72-
73-
1. Ensure your code builds without errors
74-
2. Ensure all tests pass
75-
3. Update documentation if needed
76-
4. Fill out the pull request template
77-
5. Link any related issues
78-
79-
## Testing
80-
81-
- Write tests for new functionality
82-
- Ensure existing tests pass before submitting a PR
83-
- Run the full test suite:
84-
```bash
85-
dotnet test src/AzureEventGridSimulator.sln
86-
```
87-
88-
## Reporting Issues
89-
90-
- Use the GitHub issue templates for bug reports and feature requests
91-
- Search existing issues before creating a new one
92-
- Provide as much detail as possible
14+
For detailed guidelines on contributing, CI/CD workflows, release process, and conventional commits, see the **[Contributing wiki page](https://github.com/pmcilreavy/AzureEventGridSimulator/wiki/Contributing)**.
9315

9416
## Code of Conduct
9517

96-
This project follows the [Contributor Covenant Code of Conduct](../CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
97-
98-
## Questions?
99-
100-
If you have questions, feel free to open a discussion or issue on GitHub.
18+
This project follows the [Contributor Covenant Code of Conduct](../CODE_OF_CONDUCT.md).
10119

10220
## License
10321

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "wiki"]
2+
path = wiki
3+
url = git@github.com:pm7y/AzureEventGridSimulator.wiki.git

0 commit comments

Comments
 (0)