Thanks for your interest in contributing! This project exists to teach HTTP through explicit, readable code, and contributions that support that goal are very welcome.
This project prioritizes:
- clarity over cleverness
- explicit control flow
- web standards
- educational value
When contributing, ask:
Will this make the system easier to understand?
You can help by:
- fixing bugs
- improving documentation
- adding examples
- clarifying comments
- suggesting better naming
- improving error messages
- reporting issues
Small contributions are just as valuable as big ones.
Before opening a pull request:
- keep changes focused
- write clear commit messages
- update docs if behavior changes
- explain why the change exists
PR title examples:
docs: clarify request lifecyclefix: guard return typefeat: add header helper
- prefer explicit code
- avoid hidden side effects
- no unnecessary abstractions
- readable > clever
- comments are encouraged
Docs are licensed under CC BY 4.0.
You are free to:
- fix typos
- rewrite confusing sections
- add examples
- improve explanations
When opening an issue:
- describe expected behavior
- describe actual behavior
- include minimal reproduction if possible
Please avoid:
- adding magic behavior
- hiding HTTP details
- large refactors without discussion
- adding heavy dependencies
By contributing:
- code contributions are MIT licensed
- documentation contributions are CC BY 4.0
You agree your work can be redistributed under these licenses.
Be kind. Be respectful. Teach, don’t dunk.
Thanks for helping make HTTP easier to understand ❤️