Merge pull request #60 from MartinDelille/42-contributing

Add CONTRIBUTING.md
This commit is contained in:
Michael Schramm 2019-11-12 11:26:15 +01:00 committed by GitHub
commit 857e90680c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 37 additions and 1 deletions

36
CONTRIBUTING.md Executable file
View File

@ -0,0 +1,36 @@
# Contributing
## Table of Contents
<!-- TOC depthFrom:1 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->
- [Contributing](#contributing)
- [Table of Contents](#table-of-contents)
- [Report issues](#report-issues)
- [Write code](#write-code)
- [Clone the project](#clone-the-project)
- [Run the server locally](#run-the-server-locally)
<!-- /TOC -->
## Report issues
You can [create issues](https://github.com/ohmyform/ohmyform/issues/new) to report bug or request feature.
## Write code
Here is how to setup your development environment:
### Clone the project
```
$ git clone https://github.com/ohmyform/ohmyform
```
### Run the server locally
```
$ docker-compose up
```
You should have at this point have a working instance to play with at <http://localhost:5000> within moments.

View File

@ -63,7 +63,7 @@ Moving over to Discord so that I can manage things without hassle.
<!-- TODO: add a CONTRIBUTING.md. -->
## How to Contribute
Please checkout our CONTRIBUTING.md on ways to contribute to OhMyForm.
Please checkout our [contributing guide](CONTRIBUTING.md) on ways to contribute to OhMyForm.
## Quickstart