summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrancesco Tomaselli <tomaselli.fr@gmail.com>2025-01-03 01:28:06 +0100
committerGitHub <noreply@github.com>2025-01-03 01:28:06 +0100
commitc49df2b8ee9a81ef38010e43492359f2eaefc44f (patch)
tree4e8ac67a725f9abe981eb634235ba716c1696889
parent38f8720f02493bf1660f365ad66c5093f34ef822 (diff)
Create CONTRIBUTING.md
-rw-r--r--CONTRIBUTING.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..ab1609a
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -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