summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLex Neva <github.com@lexneva.name>2021-08-18 14:07:14 -0400
committerLex Neva <github.com@lexneva.name>2021-08-18 14:07:14 -0400
commitfee506fbdad514c0cde7a1053cf92806a965fdb0 (patch)
tree273e605ccca59f77dcf4df4cbddf42d8410b816e
parent3ebc238561dd2403b19a56a0f3147c70eb4ebe3d (diff)
add CONTRIBUTING.md
-rw-r--r--CONTRIBUTING.md21
-rw-r--r--README.md2
2 files changed, 22 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..8ec1b343
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,21 @@
+We're so happy you're interested in contributing to Ink/Stitch! There's a lot that we need help with for people with all skill levels and backgrounds.
+
+Before you contribute, **please have a look at our [code of conduct](CODE_OF_CONDUCT.md)**. Thanks!
+
+Feel free to find something that interests you. If you're looking for ideas, consider this list:
+
+* coding (Python, Javascript)
+ * **please read our [coding style guide](CODING_STYLE.md)**
+* build / CI system (GitHub actions)
+ * we need someone to figure out how we can start code-signing our application
+* web design (electron UI)
+* translations ([how to translate](https://github.com/inkstitch/inkstitch/blob/main/LOCALIZATION.md))
+* issue wrangling
+ * combining duplicate issues
+ * welcoming first-time bug/issue reporters
+ * closing completed issues
+ * prioritizing bugs and features
+* artwork
+* documentation (see [gh-pages branch](https://github.com/inkstitch/inkstitch/tree/gh-pages))
+
+There's never any time commitment, we're all here to have fun. If you want to contribute, let us know and we'll add you as a collaborator.
diff --git a/README.md b/README.md
index 42ff4f2c..f9549180 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
Want to design embroidery pattern files (PES, DST, and many more) using **free, open source software?**
-Ink/Stitch aims to be a full-fledged embroidery digitizing platform based entirely on free, open source software. Our goal is to be approachable for hobbyists while also providing the power needed by professional digitizers.
+Ink/Stitch aims to be a full-fledged embroidery digitizing platform based entirely on free, open source software. Our goal is to be approachable for hobbyists while also providing the power needed by professional digitizers. We also aim to provide a welcoming opens ource environment where contributing is fun and easy.
Want to learn more?