|
| 1 | +# How to contribute |
| 2 | + |
| 3 | +Glad to hear you're interested in contributing to the project!. Thank you so much. |
| 4 | +These are some ways how you can help: |
| 5 | + |
| 6 | +> ℹ️ After cloning the repo, please add `/?devOptions=1` in the URL, so you can see additional options for development mode |
| 7 | +> Also the hostname should be either `localhost`or `127.0.0.1`. |
| 8 | +
|
| 9 | +#### Issues |
| 10 | +You can check the [Issues](https://github.com/rails/rails/issues) section and start working on some of the existing tickets. |
| 11 | + |
| 12 | +#### Bugs |
| 13 | +If you find a bug, please [create a new issue](https://github.com/leviarista/github-profile-header-generator/issues/new/choose). |
| 14 | + |
| 15 | +#### Presets |
| 16 | +Create more presets/themes: |
| 17 | +- Open the browser console. |
| 18 | +- Create your theme and copy the printed theme values from the console. |
| 19 | +- Click the "miniature" option and save the image, add it to `public/images/theme-previews/`. |
| 20 | +- Use the previuos console values to insert a new item on `/js/data/presets.json`. |
| 21 | +- Add a property called `"previewImage"` with the name of the miniature image. |
| 22 | + - For example: `"previewImage": "my-theme-preview.png"` |
| 23 | +- That's it! |
| 24 | + |
| 25 | +#### Add Background patterns |
| 26 | +- Go to `/js/data/patterns.js`, add a new case block with an appropriate name in the `getPattern` function. |
| 27 | +- After choosing a new pattern in SVG format, paste the SVG code of the image into the return value. |
| 28 | +- Change the `fill` and `fill-opacity` values that the function receives, for example: |
| 29 | + - `fill="#F12AA34"` -> `fill='%23${color}'` |
| 30 | + - `fill-opacity=0.5` -> `fill-opacity='${opacity}'` |
| 31 | +- [Optional] Add a predefined size in the getPatternDefaultSize function. |
| 32 | +- Create an appropriate thumbnail file and add it to `/public/images/patterns/`. |
| 33 | +- Go to `/partials/toolbox/background.html` and add a new button element in the `"patterns-buttons"` div section. |
| 34 | + |
| 35 | +#### Add new decorations |
| 36 | +- Place an image on `/public/images/decorations/`. |
| 37 | +- Go to `/partials/toolbox/decorations.html` and add a new button element in the `"decorations-buttons"` div section. |
| 38 | + |
| 39 | +#### Ideas or suggestions |
| 40 | +- Share them in the [discussions](https://github.com/leviarista/github-profile-header-generator/discussions) section. |
0 commit comments