Welcome!
This project follows a universal coding doctrine focused on immutability, functional purity, modularity, testing, and clarity.
Please follow these principles when contributing.
- Prefer immutable data.
- Avoid modifying variables in place.
- Pass state explicitly instead of mutating globals.
- Functions should always return the same output for the same input.
- Avoid hidden dependencies on global state or external side effects.
- Write small, composable units of code.
- Favor composition over deep inheritance or excessive coupling.
- Always handle errors explicitly.
- Fail fast and log clearly.
- Every unit of logic must have tests.
- Tests should be fast, deterministic, and isolated.
- Continuously improve readability and structure.
- Keep functions short and single-purpose.
- Eliminate duplication.
- Comment why (not just what).
- Keep
README.mdand usage docs updated.
- Validate inputs and outputs.
- Avoid unsafe practices that compromise reliability or security.
Each repository includes a CONTRIBUTING_EXAMPLES.md file that shows how to apply these principles in its specific language or environment.