Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.63 KB

File metadata and controls

34 lines (21 loc) · 1.63 KB

Contributing

Thank you for your interest in our project. Contributions are always welcome. Feel free to open an issue if you have any questions, ideas, or bugs to report, or submit pull requests to contribute code.

We are committed to fostering a welcoming, respectful, and harassment-free environment, so please be kind! 💖

Prepare

Get credentials for public usage from Marketingportal and add them to your .env File - see .env.template.

pnpm install
# it should run postinstall tasks from @db-ux/db-theme* by default, if not:
# execute this tasks manually to decode the assets using the previously made setup:
pnpm run decode-db-theme-assets

Start locally

pnpm run dev

Make changes / Before you commit

Please ensure that Husky is installed correctly to validate your changes, e.g. by running pnpm run prepare in the codebase.

Please verify you are using a valid branch name as described by the pattern in your package.json in the section validate-branch-name.

Moreover, you need to duplicate .env.template as .env and type your own email address. This ensures that you have the correct email set for this project.

Conventions

Please note that we have established code and git commit (message and branch naming) conventions, which are enforced using various linting tools.