How to contribute¶
Everyone is welcome to contribute with Suitup PHP Framework. Just fork it, make your changes as minimal as possible and create a pull request. We ask to create minimal changes because by this way it's easier to merge your request to the project in approve case.
As you want to contribute with the project there are mainly three projects that you must to know:
- Obviouslly Suitup PHP Framework
- Suitup Skeleton - a sample project
- Suitup Dev - An entire development environment project (always work in progress)
Update the documentation¶
To properly create documentation for Suitup you will need MkDocs which is a very simple way to create docs and publish with Github pages.
Get Python 3¶
Download and install python 3, there's no secrets here.
Download and install¶
If the outputs of the command
$ pip --version is somethings like
pip 19.2.2 from /usr/local/lib/python3.5/dist-packages/pip (python 3.5) (note python 3.5) so you just need to run the command
pip instead of
Deploy to Github pages¶
After work have been done deploy your changes to the
See some more information about it here
Learn how to make it better¶
CodeHilite is an extension that adds syntax highlighting to code blocks and is included in the standard Markdown library. The highlighting process is executed during compilation of the Markdown file.
Syntax highlighting not working?
CodeHilite parses code blocks and wraps them in
pre tags. If Pygments
is installed, which is a generic syntax highlighter with support for over
300 languages, CodeHilite will also highlight the code block. Pygments can
be installed with the following command: