Website for the GNU/Linux Users Group of la Laguna (Grupo de Usuarios GNU/Linux de la Laguna)
Our guides about how to contribute to this hacktoberfest
in this repository.
-
Follow this PR as an example.
- Having a GitHub account and Git installed in your device.
- Use your favorite text editor.
- Have Python 3.8+ installed in your device.
Follow these steps to contribute to this repository.
- Clone this repository.
# ssh clone - if you have two step verification enabled
git clone git@github.com:GULAG/gulag.github.io.git
# http clone
git clone https://github.com/GULAG/gulag.github.io.git
- Go into the folder
gulag.github.io
cd gulag.github.io
- Install the libraries found in
requirements.txt
pip install -r requirements.txt
- Create a branch with the date and the name of the article.
git checkout -b article/<date>_<title>
# Example
git checkout -b article/2022_10_26_my_awesome_title
- Add your article in
md
format inside the foldercontent/articles
. The article name has to follow this naming convention.
<date>
-<name>
.md- Example: 2022-10-26-my-awesome-article.md
If your article has images, create a folder with the same name as your article and add the tag {attach}
to href
and to src
.
- Example:
<center>
<a class="img-responsive" href="{attach}2022-10-26-my_awesome_article/chat.png"><img class="img-responsive" style="width:60%;height:auto;margin-right:12px;" src="{attach}2022-10-26-my_awesome_article/chat.png" alt="Image description" width="325" height="250"></a>
</center>
- To try your changes, run the following comands in terminal.
# build the site
pelican content -o output -s pelicanconf.py
# run the site in local server
pelican -l -r
#press ctrl+c to exit the local server
- Once this is ready, it's time to create your Pull Request (PR). Run the following commands to publish your branch in GitHub with all the changes.
git add .
git commit -m 'Mensage concreto de tus cambios'
git push --set-upstream origin <nombre de tu branch>
-
Now visit the repository in github.com
-
Your branch should appear next to a button that says
compare and create PR
. Click on it. -
On the next page fill in the title and body with the basic information from your article.
- Example:
Title: Article | <Your article name>
-
In the body of the PR explain the changes you made.
-
Add the label / tag of
enhancement
to your PR so it counts. Inreviewers
add GULAG/Publicadores -
Click the button
Create PR
. This will launch the CI process on the site. If it clears all the checks, congratulations! Your PR will be ready tomerge
. Wait for someone on the team to review it. -
If it didn't clear the CI check, don't worry. Go through the log and try again. Add a comment and we will help you.