|
| 1 | +# Contributing to al-folio |
| 2 | + |
| 3 | +Thank you for considering contributing to al-folio! |
| 4 | + |
| 5 | +## Pull Requests |
| 6 | + |
| 7 | +We welcome your pull requests (PRs). |
| 8 | +For minor fixes (e.g., documentation improvements), feel free to submit a PR directly. |
| 9 | +If you would like to implement a new feature or a bug, please make sure you (or someone else) has opened an appropriate issue first; in your PR, please mention the issue it addresses. |
| 10 | + |
| 11 | +Note that since [#2048](https://github.com/alshedivat/al-folio/pull/2048) al-folio uses the [prettier formatter](https://prettier.io/) for its code, meaning all new submitted code must conform to its standard. If you don't have `prettier` installed for your setup and the `prettier` code check fails when submitting a PR, you can check the referred failed action in our repo. In that action there will be an artifact with an HTML diff showing the needed changes. |
| 12 | + |
| 13 | +### Adding new social media information |
| 14 | + |
| 15 | +To add new social media information, there are a few places you might need to modify. Currently, the template supports icons from [Academicons](https://jpswalsh.github.io/academicons/), [Font Awesome](https://fontawesome.com/), and [Tabler Icons](https://tabler.io/icons). For an example PR, check [Add HAL id to socials](https://github.com/alshedivat/al-folio/pull/3206/files). Note that the information in all these files are alphabetically sorted. |
| 16 | + |
| 17 | +- \_data/socials.yml - your social media information |
| 18 | +- \_includes/metadata.liquid - add social media information to site metadata |
| 19 | +- \_includes/social.liquid - where the social media icon will be displayed |
| 20 | +- \_scripts/search.liquid.js - make the social media information appear in search |
| 21 | + |
| 22 | +## Issues |
| 23 | + |
| 24 | +We use GitHub issues to track bugs and feature requests. |
| 25 | +Before submitting an issue, please make sure: |
| 26 | + |
| 27 | +1. You have read [the FAQ section](FAQ.md) of the README and your question is NOT addressed there. |
| 28 | +2. You have done your best to ensure that your issue is NOT a duplicate of one of [the previous issues](https://github.com/alshedivat/al-folio/issues). |
| 29 | +3. Your issue is either a bug (unexpected/undesirable behavior) or a feature request. |
| 30 | + If it is just a question, please ask it in the [Discussions](https://github.com/alshedivat/al-folio/discussions) forum. |
| 31 | + |
| 32 | +When submitting an issue, please make sure to use the appropriate template. |
| 33 | + |
| 34 | +## License |
| 35 | + |
| 36 | +By contributing to al-folio, you agree that your contributions will be licensed |
| 37 | +under the LICENSE file in the root directory of the source tree. |
0 commit comments