interesting
/
aminal
mirror of https://github.com/liamg/aminal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Create CONTRIBUTING.md

This commit is contained in:
Liam Galvin 2018-10-21 15:54:31 +01:00 committed by GitHub
parent 2a3ef7644d
commit bd5d84fa24
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
CONTRIBUTING.md Normal file
View File

@ -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.