Blame view

sources/3rdparty/rackspace/php-opencloud/CONTRIBUTING.md 1.29 KB
6d9380f96   Cédric Dupont   Update sources OC...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
  Contributing to php-opencloud
  -----------------------------
  
  Welcome! If you'd like to work on php-opencloud, we appreciate your
  efforts. Here are a few general guidelines to follow:
  
  1. Use the `working` branch for your pull requests. Except in the case of
     an emergency hotfix, we will only update `master` with official releases.
  
  2. All code needs to come with unit tests. If you're introducing new code, you
     will need to write new test cases; if you're updating existing code, you will
     need to make sure the methods you're updating are still completely covered.
  
  3. Please abide by PSR code styling.
  
  4. Explaining your pull requests is appreciated. Unless you're fixing a
     minor typographical error, create a description which explains your changes
     and, where relevant, references the existing issue you're hoping to fix.
  
  5. Document your code!
  
  If you submit code, please add your name and email address to the
  CONTRIBUTORS file.
  
  Test Instructions
  -----------------
  
  ### To run unit tests:
  ```bash
  phpunit
  ```
  
  ### To run the full suite of acceptance tests:
  1. Make sure your [variables-order](http://www.php.net/manual/en/ini.core.php#ini.variables-order) is set to "EGCRS"
  2. Set your *PHP_OpenCloud_USERNAME* and *PHP_OpenCloud_API_KEY* variables
  3. Run: ```php tests/OpenCloud/Smoke/Runner.php```