Developer Workflow

This guide will walk you through setting up your development environment and submitting your first pull request.

Prepare Code

1. Create your own fork (opens in a new tab) from FOSSBilling (opens in a new tab).
2. Clone your own fork instead of the FOSSBilling repo.
3. Setup your upstream (opens in a new tab) to help keep your fork in sync. Alternatively, use the web UI.

Environments

There are multiple ways to set up your environment. Choose the one that works best for you.

Proceed to the next section once your environment is configured.

Modifying Code

1. Create a new branch under your fork. Name it something brief and relevant to what you are working on.
2. Commit your changes into the new branch.
3. If your commit is related to an existing issue, tag the issue ID in your commit message. For example: #1234 add verify checkbox. This will make your commit show within the issue history.
4. Keep each set of changes isolated into their own branches. Avoid creating branches that have mixed changes across various modules. Each branch should solve a specific problem or task.
5. Run PHPUnit tests to validate existing logic, and create new tests for any new logic.
6. When your changes are finished, you are ready to submit a pull request.

Submitting a Pull Request

1. Submit a pull request (opens in a new tab) from your forked branch targeting main on the FOSSBilling repo.
2. Clearly document what your pull request is for and any new features it introduces or changes. Tag any open issues the pull request relates to. For example: Closes #1234.
3. Submit your request.
4. Verify that the automated tests complete successfully. The status will be shown in the pull request. The tests will take a moment to execute and finish.
5. Monitor for and respond to any feedback on your request.
6. If all tests pass and at least one maintainer leaves approval, your pull request will be accepted and your update will be merged into the main FOSSBilling branch.
7. Sync your fork with the FOSSBilling upstream to now find your new code in your fork's main branch.