Thanks for your interest in contributing to Corg-Labs.
All repositories in this organization follow the same basic contribution guidelines.
- All code must be written in C
- Keep changes small and focused
- Prefer clarity over cleverness
- Follow the existing code style of the repository
- Fork the repository
- Create a feature branch:
git checkout -b your-feature-name
Build and run the project locally
Make sure existing functionality still works
- Avoid unnecessary macros
- Use meaningful variable and function names
- No compiler warnings (use -Wall -Wextra when possible)
- Update the README.md if behavior changes
- Add comments for non-obvious logic
- If the repo has a tutorial, keep it in sync with the code
- Push your branch to your fork
- Open a Pull Request against main
- What you changed
- Why you changed it
- Any trade-offs made
- Small, well-explained PRs are preferred.
If something is unclear, open an issue before starting large changes.