From 86e9dd8bd976041a31c607458fbe0ac6a81d7503 Mon Sep 17 00:00:00 2001
From: Adrian Föder <adrian@foeder.de>
Date: Wed, 07 Aug 2024 06:29:54 +0000
Subject: [PATCH] docs: add contributing notes

---
 CONTRIBUTING.md |   15 +++++++++++++++
 README.md       |    2 +-
 2 files changed, 16 insertions(+), 1 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..c9f9f8f
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,15 @@
+# How to contribute to Split
+
+## Pull requests
+
+Please follow the [Conventional Commits 1.0.0 specification](https://www.conventionalcommits.org/en/v1.0.0/) to format your commit message. One commit per change is preferred.
+
+## Testing
+
+There are two test sites under [`tests/exampleSiteWithImage`](./tests/exampleSiteWithImage) and [`tests/exampleSiteWithVideo`](tests/exampleSiteWithVideo). Please adjust those accordingly
+to the changes you have made resp. check if your change didn't introduce any [regressions](https://en.wikipedia.org/wiki/Regression_testing).
+
+You can run these using the [`Makefile`](./Makefile) found at the root of this repository:
+
+`$ make hugo-server-example-site-with-image`\
+`$ make hugo-server-example-site-with-video`
diff --git a/README.md b/README.md
index c8dfff7..f38a0a0 100644
--- a/README.md
+++ b/README.md
@@ -210,7 +210,7 @@
 
 ## Contributing
 
-Did you found a bug or got an idea for a new feature? Feel free to use the [issue tracker](https://github.com/escalate/hugo-split-theme/issues) to let me know. Or make directly a [pull request](https://github.com/escalate/hugo-split-theme/pulls).
+Did you found a bug or got an idea for a new feature? Feel free to use the [issue tracker](https://github.com/escalate/hugo-split-theme/issues) to let me know. Or make directly a [pull request](https://github.com/escalate/hugo-split-theme/pulls). See also the [Contributing](./CONTRIBUTING.md) notes.
 
 
 ## License

--
Gitblit v1.10.0