Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tomfran authored Jan 3, 2025
1 parent d2e9e4e commit 2209b9f
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# How to contribute to Typo

The goal of this theme is to be as simple as possible, hence adding or changing existing
features need 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.

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;
- refrain from breaking existing behavior, for example, make a new feature disabled by default.

<br>
Thank you, <br>
Francesco

0 comments on commit 2209b9f

Please sign in to comment.