Skip to content

Commit 7a16216

Browse files
chore: standardize CONTRIBUTING.md structure
1 parent 34d31bc commit 7a16216

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,14 @@ We target .NET 8.0 and .NET 9.0 for broad compatibility.
5656
### Testing
5757

5858
- All new features must include tests
59-
- Aim for high test coverage (80%+)
59+
- Maintain test coverage at **85%+ line coverage**
6060
- Tests should cover edge cases and spec compliance
6161
- Run the full test suite:
6262
```bash
6363
dotnet test
6464
```
6565

66-
Some tests are auto generated to comply with the [TOON specification](https://github.com/toon-format/spec/blob/main/SPEC.md). To ensure tests are
67-
aligned with the spec, execute the `specgen.sh` or `specgen.ps1` script.
66+
Some tests are auto-generated to comply with the [TOON specification](https://github.com/toon-format/spec/blob/main/SPEC.md). To ensure tests are aligned with the spec, execute the `specgen.sh` or `specgen.ps1` script.
6867

6968
## SPEC Compliance
7069

@@ -77,12 +76,14 @@ Before submitting changes that affect encoding/decoding behavior:
7776

7877
## Pull Request Guidelines
7978

80-
- **Title**: Use a clear, descriptive title (e.g., "Add support for nested arrays", "Fix: Handle edge case in decoder")
79+
- **Title**: Use a clear, descriptive title
8180
- **Description**: Explain what changes you made and why
8281
- **Tests**: Include tests for your changes
83-
- **Documentation**: Update README or XML documentation if needed
82+
- **Documentation**: Update README or documentation if needed
8483
- **Commits**: Use clear commit messages ([Conventional Commits](https://www.conventionalcommits.org/) preferred)
8584

85+
Your pull request will use our standard template which guides you through the required information.
86+
8687
## Communication
8788

8889
- **GitHub Issues**: For bug reports and feature requests
@@ -91,7 +92,12 @@ Before submitting changes that affect encoding/decoding behavior:
9192

9293
## Maintainers
9394

94-
This is a collaborative project. All maintainers have equal decision-making power. For major architectural decisions, please open a discussion issue first.
95+
This is a collaborative project. Current maintainers:
96+
97+
- [@ghost1face](https://github.com/ghost1face)
98+
- [@239573049](https://github.com/239573049)
99+
100+
All maintainers have equal and consensual decision-making power. For major architectural decisions, please open a discussion issue first.
95101

96102
## License
97103

LICENSE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
MIT License
22

3+
Copyright (c) 2025-PRESENT Daniel Destouche
34
Copyright (c) 2025-PRESENT Johann Schopplich
45

56
Permission is hereby granted, free of charge, to any person obtaining a copy

0 commit comments

Comments
 (0)