Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Contributing to SwiftNet

Thank you for your interest in contributing to SwiftNet! This guide explains the recommended workflow so your contributions can be reviewed and merged smoothly.

## How to Contribute

1. **Fork the repository.**

2. **Clone your fork:**
```bash
git clone https://github.com/<your-username>/SwiftNet.git
cd SwiftNet
```

3. **Create a feature branch:**
```bash
git checkout -b feature/your-feature-name
```

4. **Make your changes and commit them:**
```bash
git add .
git commit -m "Describe your change clearly"
```

5. **Open a Pull Request as a *draft*.**
Draft PRs allow CI to run and give you time to refine your work before requesting a formal review.

6. **Mark the Pull Request as “Ready for Review” when:**
- all tests pass
- the code builds successfully
- the changes are complete
- documentation is updated if needed

## Guidelines

- Keep PRs focused on a single feature or fix.
- Write clear commit messages.
- Follow the coding style already present in the project.
- Add or update tests when relevant.

## Questions?

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.

## 🌟 Contributor Hall of Fame

Everyone who has contributed code, documentation, or fixes to SwiftNet
is listed here as a thank-you.
13 changes: 1 addition & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,8 @@ cd SwiftNet/build
- Include the SwiftNet.h header from the `src` directory in your main source file (e.g., `main.c`).
- Link against the static library `libswiftnet.a` using your compiler.

## Contributing
### 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.

## Code Contributions
We have simple guidelines for contributing:

- Write clear and concise comments for your code.
- Ensure that the code is easy to read and follows the existing style.

We value collaboration and clean code!

## License
This project is licensed under the Apache License 2.0

## Contact
For any questions or support, feel free to open an issue or contact me at [richardfabianmain@gmail.com].
For any questions or support, feel free to open an issue or contact me at [https://t.me/deadlightreal].