Skip to content

Latest commit

 

History

History
76 lines (45 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

76 lines (45 loc) · 2.6 KB
Raw

Contribution Guidelines

Setup for Development

Clone this repository and setup your development environment configuration:

  1. Duplicate the file .env.example.php and name it .env.local.php
  2. Apply your configuration
  3. Make sure you never commit this file. (It should be git ignored per default)

Important: Have a look at the docs directory. Else you'll be missing some important instructions like for our taskrunner.

Set the environment to local

Larapress is set to run in the production environment by default. To take control over the environment you can do the following:

  1. Create a new file called .env_name.php in the app root
  2. Make it return the environment you want to apply for the cli as well as the browser
  3. Make sure you never commit this file. (It should be git ignored per default)
<?php

// This is the complete content of the .env_name.php file

return 'local';

The example above will obviously change the environment to local. (which is the default development environment we use)

Run following code in your command line:

composer install --dev -o
php artisan ide-helper:generate
chmod -R 777 app/storage
php artisan larapress:install

Adding Packages

Whenever you add a ServiceProvider that is only needed for development tasks make sure you don't add it in the app/config/app.php configuration file. Instead add it in the app/config/local/app.php file.

Workflow

We're utilizing the Git Flow with following prefixes:

  • feature/*
  • release/*
  • hotfix/*

Version Tags

We're prefixing version numbers with the letter "v" like v1.0.1 and follow the Semantic Versioning Principles.

Coding Style

The larapress coding style is a mix of the PSR-2 Coding Style Guide, Laravel and my own personal preferences.

Your best bet is to look at the code and try to adapt right now. Maybe there'll be some style guide later on but let's see if it's actually going to be required at first. Don't fear to send some pull requests I have no problem reformatting them myself at this time.

Development Environment

Don't apply changes that affect these instructions without updating them!

Language

The complete codebase including docs must be written in english. This allows us hiring experts from all over the world when needed.

Documentation

Pull Requests missing documentation won't be accepted.

TDD

Pull Requests missing tests won't be accepted.