Skip to content

contributions.md

Latest commit

 

History

History
122 lines (84 loc) · 5.22 KB

contributions.md

File metadata and controls

122 lines (84 loc) · 5.22 KB

Contribution Guide

Bug Reports

Thank you for helping us test ZEDx. We're happy to have you on the team! We need people who can troubleshoot issues patiently and communicate them clearly. As you probably know, good bug reporting takes some time and effort. If you're fine with that, then let's get started!

Found a bug already? Wonderful! We'd love to hear about it — but first you should check around to make sure you're not wasting your time on a known issue:

- Search our [Support forum](http://discuss.zedx.io/t/bug) to see if it's already been reported. - We could be working on a fix, so search our [issue tracker](https://github.com/zedx/core/issues) too.

If you've searched thoroughly and come up empty-handed, we'll welcome your report. If it's just a simple issue (a misspelled word or graphics glitch, for example) skip to the next paragraph. But if you're seeing errors, or something is clearly broken, we'll need you to gather some information first. Please head over to our Troubleshooting guide and follow the instructions there. Collect as much info as you can!

Okay, time to get writing. Head back to the Support forum and start a new discussion. Be sure to give it a title that's clear and concise, and then explain the problem thoroughly. Don't forget to mention:

- What you were doing when the problem occurred - All the information you gathered while troubleshooting - Anything you can tell us about your sever environment

Remember: the goal of a bug report is to make it easy for us to replicate the bug and fix it. You might want to read this article for some useful tips on how to write an effective bug report. And please take a moment or two to format your post so it's easy to tell what's what.

Once you've posted your report, we'd ask that you please follow the discussion that you created and wait patiently. We may need to ask for further details or clarification; but we've always got plenty to do, and it could be a while before we can give your report the time it deserves.

Pull Request Guidelines

Install Dev version

REQUIREMENTS : You must already have composer and npm installed on your machine.

For developement purpose, you might want to install to current ZEDx dev version, it's ok, all you have to do is follow these steps :

  • Run the CLI composer create-project zedx/zedx myzedx dev-develop --prefer-dist

  • Edit composer.json file

Replace

"require": {
    "zedx/core": "3.0.0-beta.3"
}

By

"repositories": [
    {
        "type": "git",
        "url": "https://github.com/zedx/core"
    }
],
"require": {
    "zedx/core": "dev-develop"
}

  • Update composer by running composer update

  • Install ZEDx using the CLI by running php artisan zedx:install (add --quick if you already have SQLite3 installed on your machine)

  • Install npm packages by running npm install

  • Compile assets by running gulp command line.

Security Vulnerabilities

If you discover a security vulnerability within ZEDx, please send an e-mail to security@zedx.io. All security vulnerabilities will be promptly addressed.

Coding Style

ZEDx follows the PSR-2 coding standard and the PSR-4 autoloading standard.

PHPDoc

Below is an example of a valid ZEDx documentation block. Note that the @param attribute is followed by two spaces, the argument type, two more spaces, and finally the variable name:

/**
 * Register a binding with the container.
 *
 * @param  string|array  $abstract
 * @param  \Closure|string|null  $concrete
 * @param  bool  $shared
 * @return void
 */
public function bind($abstract, $concrete = null, $shared = false)
{
    //
}

StyleCI

If you're code style isn't perfect, don't worry! StyleCI will automatically merge any style fixes into the ZEDx repository after any pull requests are merged. This allows us to focus on the content of the contribution and not the code style.