want to help build okommerce?
okommerce community is MIT-licensed and accepts contributions from everyone. here's how to get involved without stepping on the team's toes.
ways to contribute
code contributions — bug fixes, new modules, performance improvements. open a PR against the main branch on github.
documentation — fix typos, clarify confusing parts, add missing sections. docs live in /docs in the repo.
translations — help us improve our 5 default languages or add new ones. translation files live in /locales.
bug reports — file an issue on github. include reproduction steps, expected vs actual behavior, environment details.
community help — answer questions on the forum or github discussions.
code style
follow the existing patterns. we use .editorconfig and an automated linter. the CI will catch most issues.
- vertical-slice architecture — keep new features self-contained
- EF Core for writes, Dapper for reads
- async everywhere, no blocking calls
- tests for non-trivial logic — xUnit + Moq
PR process
- fork the repo
- create a feature branch
- commit with a clear, conventional commit message
- open a PR against
mainwith a description of what changed and why - wait for CI to pass and a maintainer to review
- address feedback, merge
contributor license agreement
contributions are licensed under MIT to match the rest of the codebase. by submitting a PR, you confirm you have the right to do so.
questions?
email contributors@okommerce.com or open a github discussion.