chore: add contributing md (#13)

kkeles · Feb 4, 2024 · 9730013 · 9730013
1 parent 204a468
commit 9730013
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,19 @@
+# Contributing
+
+1. Create a fork of the repo: https://github.com/kkeles/awsug-hugo/fork
+2. Create a local development repo based on the `exampleSite`
+```bash
+hugo new site awsug-dev
+cd awsug-dev
+git clone [email protected]:<your-fork>/awsug-hugo.git themes/awsug
+cp -r themes/awsug/exampleSite/* .
+hugo server
+```
+3. Create a branch, such as `fix/background`
+```bash
+cd themes/awsug
+git checkout -b fix/background
+git add .
+git commit -m"fix: background"
+```
+4. Do you changes in `theme/awsug`, commit, push to your fork and create a PR :tada: