Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 1.15 KB

File metadata and controls

55 lines (35 loc) · 1.15 KB

Contributing to Corg-Labs

Thanks for your interest in contributing to Corg-Labs.

All repositories in this organization follow the same basic contribution guidelines.


📌 General Rules

  • All code must be written in C
  • Keep changes small and focused
  • Prefer clarity over cleverness
  • Follow the existing code style of the repository

Before You Start

  1. Fork the repository
  2. Create a feature branch:
    git checkout -b your-feature-name

Build and run the project locally

Make sure existing functionality still works

Code Quality

  • Avoid unnecessary macros
  • Use meaningful variable and function names
  • No compiler warnings (use -Wall -Wextra when possible)

Documentation

  • 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

Submitting a Pull Request

  • Push your branch to your fork
  • Open a Pull Request against main

Describe:

  • What you changed
  • Why you changed it
  • Any trade-offs made
  • Small, well-explained PRs are preferred.

Questions

If something is unclear, open an issue before starting large changes.