From bd5d84fa245ecf351ce9786fb6e21c13c3cd0c34 Mon Sep 17 00:00:00 2001 From: Liam Galvin Date: Sun, 21 Oct 2018 15:54:31 +0100 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f8b36c8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Introduction + +Thanks for considering contributing to Aminal. + +## What can I work on? + +You can browse the [issues](https://github.com/liamg/aminal/issues) to see what is currently needed. + +Good places to get started are: + +- [Good first issues](https://github.com/liamg/aminal/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) +- [Help wanted issues](https://github.com/liamg/aminal/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) + +Simply using the terminal and experimenting with different applications is also very useful, as it helps us prioritise work and find bugs. If you find something that doesn't work yet, please [raise an issue](https://github.com/liamg/aminal/issues/new/choose). + +## I want to build X feature or fix Y bug... + +If you have an idea for a feature, please [raise an issue](https://github.com/liamg/aminal/issues/new/choose) before you do anything else. + +Feel free to start working a bug fix straight away, though a [related issue](https://github.com/liamg/aminal/issues/new/choose) is needed to go along with your merge request. +