Skip to content

Commit d06f93c

Browse files
deadlightrealMorcules
authored andcommitted
Updated readme and added contributing.md
1 parent fe0193a commit d06f93c

File tree

2 files changed

+50
-12
lines changed

2 files changed

+50
-12
lines changed

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing to SwiftNet
2+
3+
Thank you for your interest in contributing to SwiftNet! This guide explains the recommended workflow so your contributions can be reviewed and merged smoothly.
4+
5+
## How to Contribute
6+
7+
1. **Fork the repository.**
8+
9+
2. **Clone your fork:**
10+
```bash
11+
git clone https://github.com/<your-username>/SwiftNet.git
12+
cd SwiftNet
13+
```
14+
15+
3. **Create a feature branch:**
16+
```bash
17+
git checkout -b feature/your-feature-name
18+
```
19+
20+
4. **Make your changes and commit them:**
21+
```bash
22+
git add .
23+
git commit -m "Describe your change clearly"
24+
```
25+
26+
5. **Open a Pull Request as a *draft*.**
27+
Draft PRs allow CI to run and give you time to refine your work before requesting a formal review.
28+
29+
6. **Mark the Pull Request as “Ready for Review” when:**
30+
- all tests pass
31+
- the code builds successfully
32+
- the changes are complete
33+
- documentation is updated if needed
34+
35+
## Guidelines
36+
37+
- Keep PRs focused on a single feature or fix.
38+
- Write clear commit messages.
39+
- Follow the coding style already present in the project.
40+
- Add or update tests when relevant.
41+
42+
## Questions?
43+
44+
If you’re unsure about anything, feel free to message me on telegram, open an issue or start a discussion before working on a feature.
45+
46+
## 🌟 Contributor Hall of Fame
47+
48+
Everyone who has contributed code, documentation, or fixes to SwiftNet
49+
is listed here as a thank-you.

README.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,8 @@ cd SwiftNet/build
3636
- Include the SwiftNet.h header from the `src` directory in your main source file (e.g., `main.c`).
3737
- Link against the static library `libswiftnet.a` using your compiler.
3838

39-
## Contributing
40-
### Contributions are very welcome! If you'd like to improve the library or fix any issues, feel free to fork the repository and submit a pull request.
41-
42-
## Code Contributions
43-
We have simple guidelines for contributing:
44-
45-
- Write clear and concise comments for your code.
46-
- Ensure that the code is easy to read and follows the existing style.
47-
48-
We value collaboration and clean code!
49-
5039
## License
5140
This project is licensed under the Apache License 2.0
5241

5342
## Contact
54-
For any questions or support, feel free to open an issue or contact me at [[email protected]].
43+
For any questions or support, feel free to open an issue or contact me at [https://t.me/deadlightreal].

0 commit comments

Comments
 (0)