Contribution¶

You can create pull requests to fix issues you've spotted, add new information or rephrase things so that they are better interpreted by readers.

Resources¶

Everything about the site generator (Zensical) and formatting is in their documentation.

• Zensical repository
• Zensical documentation
• Zensical Studio

Contribution guidelines¶

Keep it clear¶

We may ask you to change your formatting occassionally to make it easier for current and future contributors. This also ensures consistency across the entire guide.

Squash your commits when needed¶

If you are experienced with Git or software development, this is self explanatory. For beginners, it is recommended to squash multiple commits of small changes together if the changes are marginal. Check the following tutorials about commit squashing for your IDE of choice:

• Visual Studio Code
• IntelliJ IDEA

LLM policy¶

This project disencourages the usage of large language models (LLMs) by team members and contributors. While there are equally valid reasons why a team of developers refuse to use LLMs, the primary reasons we choose this policy is outlined below:

Loss of context¶

We believe using LLMs make us forget about very important decisions taken when developing software. While the reasons are not entirely based on scientific objectivity, it is reasonable to expect that the user of an LLM may develop less of a hands-on approach and check everything less often.

Bad quality¶

LLM generated visuals cause distrust amongst our users. Not only that, they are a very contentious point of discussion, mostly towards the side of negative sentiment. Since we already have to make our own screenshots, assets, icons or record videos, we do not need to rely on LLM generated visuals.