Skip to content

Latest commit

 

History

History
50 lines (40 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

50 lines (40 loc) · 1.86 KB
Raw

Welcome!

So you are interested in contributing to the callingallpapers-API? That's great!

But how to start? Have a look at the issue-list. We try to mark easy things as "Easy Pick". There's something missing in your eyes? Feel free to add it. Either by sharing your ideas or concerns via a new issue or by adding a Pull-Request.

For that you'll want to setup the API on your dev-environment. To do so:

Setup

  1. Fork the project on github
  2. Clone your repository onto your dev-machine.
git clone git@github.com:<your github-username>/callingallpapers-api.git
  1. Move to the newly created folder:
cd callingallpapers-api
  1. Install the dependencies by running composer update. This will also include all development-stuff that is needed.
  2. Create the settings-file by copying the provided template 
    cp config/settings.php.dist config/settings.php
    (you can edit it if you want to but the default settings should be OK)
  3. Start PHPs internal webserver 
    php -S localhost:8000 -t public
  4. Point your browser to your API

Now you should be up and running to contribute to the API. Your API does not contain any data at that point so you might want to add some stuff at this point.

Coding-Guidelines

We follow the PSR-2 Coding standard. To fix issues with that easily we've added the php-cs-fixer to the development-tools. So you can always correct issues by running ./vendor/bin/php-cs-fixer. That should take care of everything.

Code of Conduct

This project is open to everyone as long as you follow the rules. They basically boil down to "behave yourself and respect others!"