Skip to content

Commit c1a8c20

Browse files
authored
📝 Add doc about asset proposals (zenika-open-source#27)
1 parent 0d15e4c commit c1a8c20

File tree

3 files changed

+141
-0
lines changed

3 files changed

+141
-0
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Play on **[https://pimpmyduck.zenika.com](https://pimpmyduck.zenika.com)**.
1010

1111
Contributions, issues and feature requests are welcome! Feel free to check [issues page](https://github.com/zenika-open-source/my-zenikanard/issues).
1212

13+
See the [Asset proposal documentation](./proposals/README.md), if you want to add a new asset to Pimp My Duck.
14+
1315
All development instructions are explained in the [contributing guide](./.github/CONTRIBUTING.md).
1416

1517
## License

proposals/README.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# How to propose an asset to "Pimp My Duck" ?
2+
3+
To propose a new asset you have to create a PR with :
4+
- The asset as SVG file into the `/proposals` folder
5+
- Give the asset name and category into the PR description
6+
7+
Here is the category list:
8+
- Eyes
9+
- Glasses
10+
- Hair
11+
- Hats
12+
- Mouth
13+
- Faces
14+
- Wears
15+
- Body tatoo
16+
- Accessories
17+
18+
The asset can be built using the [Zenikanard template](./zenikanard_template.svg) SVG file as reference.
19+
20+
The final asset SVG file must NOT contain the Zenikanard, it's just a template to help the design.
21+
22+
After the PR, reviewed and merged. A maintainer will integrate it into "Pimp My Duck".

0 commit comments

Comments
 (0)