Contributing

Contributing

HOF is open source. Contributions are welcome. Here's how to be useful.

ways to contribute

Effort	Impact	What
5 min	⭐	Star the repo. Seriously, it helps.
10 min	⭐⭐	File a thoughtful issue with a repro case
30 min	⭐⭐⭐	Improve docs (this wiki, or /docs in the repo)
1-3 hrs	⭐⭐⭐⭐	Fix a good-first-issue bug
Days	⭐⭐⭐⭐⭐	Build a new facet type, integration, or feature

before you start

1. Check the Roadmap. Make sure what you want to build aligns with where we're going.
2. Open an issue first for anything non-trivial. We'd rather steer you before you spend the time than reject a 1000-line PR.
3. One PR, one concern. Don't bundle "fix typo" with "rewrite the indexer."

setup

See Architecture → Dev Environment.

the PR checklist

Before opening a PR:

• Tests added or updated (where it makes sense)
• composer test passes
• npm run test passes
• npm run lint clean
• Commit messages follow Conventional Commits
• Docs updated if behavior changed
• PR description explains why, not just what

code style

• PHP: WordPress Coding Standards + PSR-12 hybrid (PHPCS config in repo)
• JS/TS: ESLint + Prettier (configs in repo)
• Markdown (docs): 100-char soft wrap, sentence-per-line for diffs

review timeline

We aim to triage PRs within 7 days. Complex PRs may take longer. Friendly nudges welcome after that window.

license

By contributing, you agree your contributions are licensed under whatever license HOF ultimately ships under (TBD, leaning open). Until that's locked, contributions are accepted under the understanding that they'll be re-licensed accordingly.

code of conduct

We expect everyone — contributors, users, maintainers — to follow the Code of Conduct. TL;DR: don't be a jerk.