Skip to content

Commit 885d16b

Browse files
docs: contribution optimizations (#5154)
* docs: contribution optimizations Added instructions for setting up credentials and handling .env file issues. * Update Husky installation instructions Added instructions to run 'npm run prepare' for Husky validation. * auto update snapshots (#5155) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * auto update snapshots (#5171) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 5a2d210 commit 885d16b

File tree

5 files changed

+3
-1
lines changed

5 files changed

+3
-1
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ node node_modules/@db-ux/db-theme-icons/build/scripts/index.js
1717
node node_modules/@db-ux/db-theme-illustrative-icons/build/scripts/index.js
1818
```
1919

20+
If you're contributing from a fork in your user space, please also set up those credentials from the Marketing portal in your fork repository as repository secrets. You need these credentials for the pipeline to decrypt the brand assets correctly.
21+
2022
> [!NOTE]
2123
> If you missed setting up the `.env`-file before running `npm install`, you may need to re-install your packages to ensure the postinstall scrips are executed for decrypting the fonts and other artifacts (`rm --recursive --force node_modules/@db-ux/db-theme* && npm update @db-ux/db-theme`)
2224
@@ -29,7 +31,7 @@ npm run dev
2931

3032
## Make changes / Before you commit
3133

32-
Please ensure that **Husky** is installed correctly to validate your changes.
34+
Please ensure that **Husky** is installed correctly to validate your changes, e.g. by running `npm run prepare` in the codebase.
3335

3436
Please verify you are using a valid branch name as described by the pattern in your [`package.json`](./package.json) in the section `validate-branch-name`.
3537

Loading
1 Byte
Loading
-3 Bytes
Loading
3 Bytes
Loading

0 commit comments

Comments
 (0)