Contributing
We welcome contributions from the community. Please read this guide before submitting your first pull request.
Accepted Contributions
The following types of contributions are accepted into the Mahalaxmi project:
- Bug fixes with a linked issue.
- New features discussed in an open issue or RFC.
- Documentation improvements and corrections.
- Performance improvements backed by benchmarks.
- Test coverage additions.
- Dependency upgrades (minor or patch).
PR Process
- Fork the repository on GitHub.
- Create a feature branch from main (e.g. feat/my-change).
- Implement your changes with clear, focused commits.
- Add or update tests to cover your changes.
- Open a pull request against the main branch.
- The CLA check bot verifies your CLA signature.
- Maintainers review your PR and may request changes.
- Once approved, your PR is merged.
Code Style
- Follow the existing code style — run the linter before opening a PR.
- Write self-documenting code; add comments only where logic is non-obvious.
- Keep pull requests small and focused on a single concern.
- Include a clear description in the PR body explaining what and why.
- All public API surfaces must have JSDoc / TSDoc annotations.
Full Contributing Guide
For the complete contributor reference, including environment setup, testing requirements, and release process, see CONTRIBUTING.md on GitHub.