Skip to content

Commit 8d7d140

Browse files
committed
add contributing guidelines to the repository
1 parent 10d59df commit 8d7d140

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

CONTRIBUTING.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contributing to the TUIC Protocol
2+
3+
Thank you for your interest in contributing to the TUIC Protocol!
4+
5+
**Every contribution, no matter how small, is valuable.**
6+
7+
Before you begin, please review our [Code of Conduct](https://github.com/tuic-protocol/tuic#coc-ov-file) to ensure a welcoming and respectful community for everyone.
8+
9+
## Understanding the Project
10+
11+
The TUIC project standardizes a network proxy protocol. This repository focuses on the protocol specification itself, not on specific implementations.
12+
13+
Key principles guiding TUIC's development:
14+
15+
- **Community-Driven:** We value collaboration and diverse perspectives. All changes should be discussed and agreed upon by the community.
16+
- **Standardization:** Our goal is a clear, stable, and unambiguous protocol specification. Contributions should address edge cases and ensure consistent behavior across implementations.
17+
- **Implementation-Agnostic:** The specification should be independent of any particular implementation. We focus on refining the protocol design, not implementation details.
18+
- **Simplicity:** The protocol should be easy to understand and implement. Contributions should minimize complexity and strive for elegance.
19+
20+
## Contributing to TUIC Implementations
21+
22+
While this repository focuses on the protocol specification, the TUIC community also maintains various implementations. Contributions to these implementations are highly welcome! You can find a list of implementations [here](https://github.com/tuic-protocol/tuic?tab=readme-ov-file#implementations).
23+
24+
## Contribution Process
25+
26+
1. **Start a Discussion:** Before making significant changes, open an issue to discuss your proposal with the community. This helps ensure your work aligns with the project's goals and prevents wasted effort.
27+
28+
2. **Fork, Branch, and Make Changes:** Follow the standard GitHub workflow: fork the repository, create a branch, and make your changes.
29+
30+
3. **Submit a Pull Request:** Create a pull request with a clear and detailed description of your changes and the reasoning behind them.
31+
32+
4. **Iterate and Refine:** Be prepared to revise your pull request based on feedback from maintainers and other contributors.

0 commit comments

Comments
 (0)