florent/pages
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update CONTRIBUTING.md with adding social media info

Browse Source
This commit is contained in:
George 2025-07-16 12:57:37 -03:00 committed by GitHub
parent f1406c47f7
commit f9d8ab340c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@ -10,6 +10,15 @@ If you would like to implement a new feature or a bug, please make sure you (or
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.
### Adding new social media information
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.
- _data/socials.yml - your social media information
- _includes/metadata.liquid - add social media information to site metadata
- _includes/social.liquid - where the social media icon will be displayed
- _scripts/search.liquid.js - make the social media information appear in search
## Issues
We use GitHub issues to track bugs and feature requests.