diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100755 index 00000000..a81361ad --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing + +## Table of Contents + + + +- [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) + + + +## 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 within moments. diff --git a/README.md b/README.md index 92a39f0f..801d8fd6 100755 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ Moving over to Discord so that I can manage things without hassle. ## 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