Contributing
Shekyl is open source. Here's how to get involved.
Get Started
GitHub Repository
Browse the source code, fork the project, and submit pull requests.
View on GitHub →Report a Bug
Found an issue? Open a GitHub issue with a clear description of the problem.
Open an Issue →Documentation
Technical specs, design documents, and protocol references.
Read the Docs →Get in Touch
Questions or ideas? Reach the maintainers by email.
Email →Contribution Guidelines
Shekyl follows the C4 (Collective Code Construction Contract) process, a proven collaboration model for open-source projects.
Patch Requirements
- Patches should be self-contained — one patch per issue, feature, or logical change.
- Follow the code style of the chunk you are modifying.
- A patch must compile cleanly and pass project self-tests on the principle target platform.
- Commit messages should have a concise subject line (under 50 characters) with an optional longer body.
- PGP signing of commits is strongly encouraged.
Pull Request Process
- Fork the repository and work on your fork
- Rebase your branch before submitting — no merge commits
- Create a pull request back to the project
- Maintainers review using the platform interface; PRs remain open for at least 168 hours (1 week) unless urgent
- A new contributor who makes a correct patch is invited to become a Maintainer
Licensing
Shekyl uses the BSD-3-Clause license. All contributions use the same license as the project. Patches are owned by their authors — there is no copyright assignment process.
Key Principles
- • Copyrights are owned collectively by all contributors
- • Everyone has an equal right to become a contributor
- • Contributors are responsible for identifying themselves in the contributor list