From c49df2b8ee9a81ef38010e43492359f2eaefc44f Mon Sep 17 00:00:00 2001 From: Francesco Tomaselli Date: Fri, 3 Jan 2025 01:28:06 +0100 Subject: Create CONTRIBUTING.md --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 CONTRIBUTING.md 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. + +
+Thank you,
+Francesco -- cgit v1.2.3