Skip to content

Latest commit

 

History

History
27 lines (17 loc) · 1.17 KB

File metadata and controls

27 lines (17 loc) · 1.17 KB

How to contribute to Typo

The goal of this theme is to be as simple as possible, hence adding or changing existing features needs some thought.

Any change that is too niche or heavily tailored to a specific developer's need will be rejected, as that would make some features cumbersome to set up.

To avoid unnecessary work, please start a discussion or open an issue with a proposal.

Guidelines

Any other reasonable changes are more than welcome. Keep in mind the guidelines:

  • keep the code as minimal as possible, and avoid comments in the code unless needed;
  • keep the parameters (e.g. in hugo.toml) as concise and clear as possible;
  • update the wiki if needed, trying to maintain the current style of writing;
  • run make format to format JS and CSS files before committing: you need to install node for this.

On Breaking Changes

You should avoid breaking existing configs when possible, or you should have a good reason to do so and explain it in your PR.

When introducing a styling change, aim to keep it disabled by default to avoid tweaking people's websites without config changes.



Thank you,
Francesco