Skip to content

Commit 6b26984

Browse files
chore: standardize CONTRIBUTING.md structure
1 parent 155ccce commit 6b26984

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ We support Python 3.8 and above (including Python 3.13 and 3.14).
5555
### Testing
5656

5757
- All new features must include tests
58-
- Maintain test coverage at **85%+ (enforced in CI)**
58+
- Maintain test coverage at **85%+ line coverage**
5959
- Tests should cover edge cases and spec compliance
6060
- Run the full test suite:
6161
```bash
@@ -76,27 +76,30 @@ Before submitting changes that affect encoding/decoding behavior:
7676

7777
## Pull Request Guidelines
7878

79-
- **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
8080
- **Description**: Explain what changes you made and why
8181
- **Tests**: Include tests for your changes
82-
- **Documentation**: Update README or docstrings if needed
82+
- **Documentation**: Update README or documentation if needed
8383
- **Commits**: Use clear commit messages ([Conventional Commits](https://www.conventionalcommits.org/) preferred)
8484

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

8789
- **GitHub Issues**: For bug reports and feature requests
8890
- **GitHub Discussions**: For questions and general discussion
8991
- **Pull Requests**: For code reviews and implementation discussion
9092

91-
## Co-Maintainers
93+
## Maintainers
9294

9395
This is a collaborative project. Current maintainers:
9496

95-
- @bpradana
96-
- @davidpirogov
97-
- @xaviviro
97+
- [@xaviviro](https://github.com/xaviviro)
98+
- [@davidpirogov](https://github.com/davidpirogov)
99+
- [@bpradana](https://github.com/bpradana)
100+
- [@Justar96](https://github.com/Justar96)
98101

99-
All maintainers have equal decision-making power. For major architectural decisions, please open a discussion issue first.
102+
All maintainers have equal and consensual decision-making power. For major architectural decisions, please open a discussion issue first.
100103

101104
## License
102105

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
MIT License
22

3-
Copyright (c) 2025-PRESENT Johann Schopplich
43
Copyright (c) 2025-PRESENT Xavi Vinaixa
54
Copyright (c) 2025-PRESENT David Pirogov
65
Copyright (c) 2025-PRESENT Justar
6+
Copyright (c) 2025-PRESENT Johann Schopplich
77

88
Permission is hereby granted, free of charge, to any person obtaining a copy
99
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)