Welcome to the x0 JavaScript Framework project! We appreciate your interest in improving our codebase. Whether you’re fixing a typo, reporting a bug, or proposing a new feature, your contribution is highly valued.
- Fork & Clone the repository.
- Create a branch for your work (
feature/xyz,fix/bug-abc, etc.). - Push your changes to your branch.
- Create a Pull Request (PR) describing your changes.
- Wait for your PR to be reviewed and merged.
We are passionate about clean code! Please:
- Strive for clarity: Write readable, maintainable code.
- Refactor where necessary.
- Call out and improve non-clean-code if you spot it.
Recommended reading: Clean Code by Robert C. Martin
- Add a public signing key to GitHub.
- Prefer using Smartcards with
openssh/ssh-agentfor commit signing. - See GitHub: Commit Signature Verification for setup instructions.
- Email us at x0@webcodex.de for questions, feature requests, or improvement ideas.
- For technical discussions, use GitHub Discussions if enabled.
- Search existing issues here before opening a new one.
- If your bug is new, create an issue and include:
- A descriptive title
- A clear explanation of the problem
- Steps to reproduce
- Expected vs. actual behavior
- Relevant code sample or test case
- Whitespace, indentation, comments, typo corrections, and other cosmetic changes are always welcome!
- Please use the provided issue templates and PR templates for a streamlined process.
We’re excited to see your contributions. Thank you for making x0-Framework better!
x0 Framework Lead Developer Claus Prüfer