Skip to content

Commit 800959e

Browse files
d-koppenhagennmergetmfranzke
authored
docs: update contribution notes (#4245)
* docs: update contribution notes * Update CONTRIBUTING.md Co-authored-by: Maximilian Franzke <[email protected]> --------- Co-authored-by: Nicolas Merget <[email protected]> Co-authored-by: Maximilian Franzke <[email protected]>
1 parent a3e8866 commit 800959e

File tree

2 files changed

+31
-2
lines changed

2 files changed

+31
-2
lines changed

.env.template

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
11
# It will force the user to add an e-mail for this project, before committing.
22
3+
4+
# Get credentials for public usage:
5+
# https://marketingportal.extranet.deutschebahn.com/marketingportal/Design-Anwendungen/db-ux-design-system/resources/db-theme
6+
ASSET_PASSWORD=ABC
7+
ASSET_INIT_VECTOR=ABC

CONTRIBUTING.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,35 @@ Thanks for your interest in our project. Contributions are welcome. Feel free to
44

55
We are committed to fostering a welcoming, respectful, and harassment-free environment. Be kind!
66

7-
## Before you commit
7+
## Prepare
8+
9+
Get credentials for public usage from [Marketingportal](https://marketingportal.extranet.deutschebahn.com/marketingportal/Design-Anwendungen/db-ux-design-system/resources/db-theme) and add them to your [`.env` File](./.env) - see [`.env.template`](./.env.template).
10+
11+
```shell
12+
npm install
13+
# it should run postinstall tasks from @db-ux/db-theme* by default, if not:
14+
# execute this tasks manually to decode the assets using the previously made setup:
15+
node node_modules/@db-ux/db-theme-fonts/build/scripts/index.js
16+
node node_modules/@db-ux/db-theme-icons/build/scripts/index.js
17+
node node_modules/@db-ux/db-theme-illustrative-icons/build/scripts/index.js
18+
```
19+
20+
> I you missed the step before the `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 -rf node_modules/@db-ux/db-theme* && npm update @db-ux/db-theme`)
21+
22+
## Start locally
23+
24+
```shell
25+
npm run build
26+
npm run dev
27+
```
28+
29+
## Make changes / Before you commit
830

931
Please make sure that husky is installed correctly to validate your changes.
1032

11-
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.
33+
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`.
34+
35+
Moreover, you need to duplicate [`.env.template`](./.env.template) as [`.env`](./.env) and type your own email address. This ensures that you have the correct email set for this project.
1236

1337
### Conventions
1438

0 commit comments

Comments
 (0)