Skip to main content
Lunar is an open source project and welcomes contributions of all kinds, from bug reports and documentation improvements to new features and code fixes.

​
Monorepo

Lunar uses a monorepo at lunarphp/lunar to manage its codebase. All packages, tests, and admin panel code live in a single repository. Monorepos are common in large projects and allow changes that span multiple packages to be developed and reviewed together.

​
Contributing Code

The basic process for contributing code to Lunar is:
  1. Fork the lunarphp/lunar monorepo
  2. Clone the fork locally
  3. Create a new branch for the change
  4. Make changes and write tests
  5. Ensure the full test suite passes
  6. Submit a pull request
For a step-by-step walkthrough of setting up the monorepo inside a Laravel application, see the Local Development guide.

​
Coding Standards

Lunar follows the Laravel coding style and uses Laravel Pint to enforce it. Before submitting a pull request, run Pint from the repository root: 
vendor/bin/pint

​
Running Tests

Lunar uses Pest for its test suite. Tests can be run from the repository root: 
vendor/bin/pest
All existing tests must continue to pass, and new features or bug fixes should include corresponding test coverage.

​
Reporting a Bug

If a bug is discovered, please open a GitHub issue on the lunarphp/lunar repository. The issue should include: At minimum:
  • A clear title and description of the issue
  • Steps to reproduce the behavior
Ideally:
  • The version of Lunar, PHP, and Laravel in use
  • An accompanying pull request with a failing test that demonstrates the issue
Providing as much detail as possible gives the issue the best chance of being resolved quickly. Creating an issue does not guarantee immediate activity; maintainers review issues as time allows.
Security vulnerabilities should not be reported as public issues. See the Security page for responsible disclosure instructions.

​
Proposing a Feature

Before investing time on a new feature, it is strongly recommended to start a discussion first. This allows the community and maintainers to provide feedback on whether the feature aligns with Lunar’s direction before any code is written. Prototyping the feature alongside the discussion is welcome if it helps illustrate the proposal.

​
Making a Pull Request

When submitting a pull request, the repository provides a template to guide the submission. A well-structured pull request should include:
  • A title that clearly summarizes the change
  • A description explaining what the change does and why it is valuable
  • References to any related issues (e.g., Fixes #123)
  • A label of bug, enhancement, or feature
  • Automated tests with adequate coverage
  • Any relevant documentation updates
Pull requests that are missing key information or are unclear in their purpose may be delayed or closed.

​
Documentation

Lunar’s documentation is maintained in the lunarphp/docs repository. It is built with Mintlify and all content is written in MDX. To contribute documentation changes:
  1. Fork the lunarphp/docs repository
  2. Install the Mintlify CLI and run the dev server locally
  3. Make changes and verify they render correctly
  4. Submit a pull request
npm i -g mint
mint dev
Any new page must also be added to the docs.json navigation configuration, or it will not appear in the sidebar.