Contributing

Hey, thanks for your interest in contributing to Dokploy! We appreciate your help and taking your time to contribute.

Before you start, please first discuss the feature/bug you want to add with the owners and community via github issues.

We have a few guidelines to follow when contributing to this project:

Commit Convention

Before you create a Pull Request, please make sure your commit message follows the Conventional Commits specification.

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Must be one of the following:

feat: A new feature
fix: A bug fix
docs: Documentation only changes
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
refactor: A code change that neither fixes a bug nor adds a feature
perf: A code change that improves performance
test: Adding missing tests or correcting existing tests
build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
chore: Other changes that don't modify src or test files
revert: Reverts a previous commit

Example:

feat: add new feature

The main branch is the source of truth and should always reflect the latest stable release.
Create a new branch for each feature or bug fix.
Make sure to add tests for your changes.
Make sure to update the documentation for any changes Go to the docs.dokploy.com website to see the changes.
When creating a pull request, please provide a clear and concise description of the changes made.
If you include a video or screenshot, would be awesome so we can see the changes in action.
If your pull request fixes an open issue, please reference the issue in the pull request description.
Once your pull request is merged, you will be automatically added as a contributor to the project.

Thank you for your contribution!

To run the docs locally, run the following command:

pnpm run docs:dev

To build the docs, run the following command:

pnpm run docs:build

To run the website locally, run the following command:

pnpm run website:dev

To build the website, run the following command:

pnpm run website:build