Add contributing guidelines

README.md

@@ -10,13 +10,14 @@ for lazy code generation and a library of useful words.
 ## Contributing
 
 The best way to contribute would be try to write a game! Then we can,
-at the same time improve gbforth to make it more useful.
+at the same time, improve gbforth to make it more useful.
 
-If you would like to contribute, please have a look to the issues in
-GitHub:
+For more detailed guidelines **[read the contribution guide](https://ams-hackers.github.io/gbforth/contribute)**.
+
+Also have a look to the issues in GitHub:
 
 - [General issues](https://github.com/ams-hackers/gbforth/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+-label%3Aconformance+)
-- [ANS Comformance issues](https://github.com/ams-hackers/gbforth/milestones)
+- [ANS Conformance issues](https://github.com/ams-hackers/gbforth/milestones)
 
 ## Install
 

docs/contribute.md

@@ -0,0 +1,52 @@
+# Contributing to gbforth
+
+First of all, thank you for wanting to contribute to this project! 💚
+
+This page contains a few guidelines for contributing to gbforth. Keep in mind
+they are mostly _guidelines_, not hard rules. Use your best judgement and in
+case of doubt, don't hesitate to ask questions!
+
+## 🐞 Reporting a bug
+
+- Search the [issues](https://github.com/ams-hackers/gbforth/issues) and check if the bug is not already reported.
+- If not, create a [new issue](https://github.com/ams-hackers/gbforth/issues/new). Make sure to include a clear description of the issue, and if possible attach a (minimal) code sample that demonstrates the bug.
+
+## ⚡️ Fixing bugs
+
+- Check the [known bugs](https://github.com/ams-hackers/gbforth/labels/bug) if you want to help out.
+- Open a [new pull request](https://github.com/ams-hackers/gbforth/compare/?expand=1) with the fix.
+- Make sure to include a clear description of the problem and solution.
+- Add the related issue number if one exists.
+
+## 🌀 Refactoring and formatting existing code
+
+- Changes that are cosmetic in nature and do not add anything substantial to the performance, functionality, or stability of gbforth will generally not be accepted.
+
+## ✅ Improving ANS Forth conformance
+
+- Check the [ANS conformance milestones](https://github.com/ams-hackers/gbforth/milestones) to track the progress.
+- Ensure that the runtime and compile time behaviour of new words is working correctly (as far as is possible/reasonable).
+- Write at least a basic test for the new word.
+- Open a [new pull request](https://github.com/ams-hackers/gbforth/compare/?expand=1) with your changes.
+
+## 🚀 Do you want to add a new feature or change an existing one?
+
+- Consider suggesting new features in the [issues](https://github.com/ams-hackers/gbforth/issues/new) before writing any code.
+- Open a [new pull request](https://github.com/ams-hackers/gbforth/compare/?expand=1) with your changes.
+- Make sure to include a clear description of the change.
+
+## 👾 Did you write a game or example?
+
+- Add your example to the `examples/` folder.
+- Make sure to update the [Makefile](https://github.com/ams-hackers/gbforth/blob/master/Makefile) so your example gets build.
+- Open a [new pull request](https://github.com/ams-hackers/gbforth/compare/?expand=1) to merge your example.
+
+## 📖 Do you want to contribute to the documentation?
+
+- Check the [issues for docs](https://github.com/ams-hackers/gbforth/labels/docs) for ideas.
+- Make sure to add an item to the [table of contents](https://github.com/ams-hackers/gbforth/blob/master/docs/index.md#table-of-contents) if you created a new page.
+- Open a [new pull request](https://github.com/ams-hackers/gbforth/compare/?expand=1) with your changes.
+
+## ❓ Do you have questions about using or modifying gbforth?
+
+- Feel free to [open an issue](https://github.com/ams-hackers/gbforth/issues/new) with your question.

docs/index.md

@@ -20,3 +20,4 @@ For further information, visit the page of the project at
 - [Internals](./internals.md)
 - [Word Index](./words.md)
 - [Libraries](./libs.md)
+- [Contribute](./contribute.md)