shlomifish.org Contributing guidelines [by Shlomi Fish]


Table of Contents

Docker script

perl bin/docker-ci-run.pl --cleanrun 2>&1 | tee "${HOME}/shlomif-homepage.build.out.txt"

Project Directory Structure

The bin/ directory contains sources for executables, either those placed there by git, or those by cookiecutter and the rest of ./gen-helpers. Most of them can and should assume that the PWD is at ./bin/..: the repository root.

The Tests/ directory contains test programs, either ones written in Python and which have a .py extension, or written in Perl and which have a .t extension.

bash -x bin/link-checker-for-shlomifish.org.bash runs an internal-hyperlinks checker. It is not run implicitly because it takes a lot of time and resources. bash -x bin/link-checker-for-shlomifish.org.bash --only-check-site-flow is also available.

src/ contains sources for pages ( *.xhtml.tt2, *.html.tt2 ) as well as images ( *.png / etc. ).

lib/sass/ contains SCSS sources ( *.scss ; SASS/SCSS guide)