Thank you for your interest in contributing! To help keep the project healthy and maintainable, please follow these guidelines:
- Start by reading the README and the documentation at blogmore.davep.dev.
- If you plan to use AI tools to contribute, you must read and follow both AGENTS.md and THEME_DEVELOPMENT_GUIDELINES.md.
- For non-trivial changes:
- Check for existing discussions, issues, and old (including closed) PRs to avoid duplicating work or missing context.
- Start a new discussion describing your intended change and get feedback before you code.
- Trivial changes (typos, small doc fixes, etc.) can be submitted directly without prior discussion.
- If you use AI to help with your PR, clearly state what tool(s) you used in your PR description.
- Follow the code style and architecture described in AGENTS.md.
- Run
make checkallbefore submitting to ensure your code passes type checks, linting, formatting, spellcheck, and tests. - Add or update tests for any new or changed functionality.
- Update documentation and
blogmore.yaml.exampleif you add or change user-facing features or config options. - Add a
ChangeLog.mdentry for every feature or bugfix PR. - For changes to CSS, templates, or theming, read THEME_DEVELOPMENT_GUIDELINES.md in full and follow its rules strictly.
- Keep commits focused and use imperative commit messages ("Add feature", not "Added").
- Be responsive to review feedback and willing to revise your PR.
- If your change is breaking or significant, provide migration notes and update docs as needed.
I appreciate your help in making BlogMore better!