Skip to content

Latest commit

 

History

History
52 lines (30 loc) · 1.26 KB

howtocontribute.rst

File metadata and controls

52 lines (30 loc) · 1.26 KB

How to contribute

Preparing your environment

Start by creating a folder for the project. Create a python3 virtual environment on that folder with

python3 -m venv venv

Fork the project on GitHub and clone it inside the project folder.

Install pelican and pelican-fontawsome

pip install requirements_dev.txt

Seeing the local version of the site

Start by reading pelican documentation, it's quick and easy and you will need it. After that you can see the site with:

$ pelican --listen

Of course this wont work if you have nothing on the output directory. To create the output you must first do

$ pelican content

Creating a branch for development

You must create a branch for development of your feature, otherwise you will be editing your master code. Use a meaningfull name like:

git checkout -b fix_whatyouarefixing

You will now be in your branch and you can modify and test the code.

Making a pull request

When you finish working on the code you will have to make a pull request on GitHub. Please be patient because the approval process may take some time.

Happy Python hacking!