www.aleph1.co.uk Git - yaffs-website/blob - vendor/cebe/markdown/CONTRIBUTING.md

   1 Contributing
   2 ============
   3
   4 First of all, **thank you** for contributing, **you are awesome**! :)
   5
   6 If you have an idea or found a bug, please [open an issue](https://github.com/cebe/markdown/issues/new) on github.
   7
   8 If you want to contribute code, there a few rules to follow:
   9
  10 - I am following a code style that is basically [PSR-2](http://www.php-fig.org/psr/2/) but with TABS indentation (yes, I really do that ;) ).
  11   I am not going to nit-pick on all the details about the code style but indentation is a must. The important part is that code is readable.
  12   Methods should be documented using phpdoc style.
  13
  14 - All code must be covered by tests so if you fix a bug or add a feature, please include a test case for it. See below on how that works.
  15
  16 - If you add a feature it should be documented.
  17
  18 - Also, while creating your Pull Request on GitHub, please write a description
  19   which gives the context and/or explains why you are creating it.
  20
  21 Thank you very much!
  22
  23
  24 Running the tests
  25 -----------------
  26
  27 The Markdown parser classes are tested with [PHPUnit](https://phpunit.de/). For each test case there is a set of files in
  28 the subfolders of the `/tests` folder. The result of the parser is tested with an input and an output file respectively
  29 where the input file contains the Markdown and the output file contains the expected HTML.
  30
  31 You can run the tests after initializing the lib with composer(`composer install`) with the following command:
  32
  33         vendor/bin/phpunit
  34
  35 To create a new test case, create a `.md` file a`.html` with the same base name in the subfolders of
  36 the `/tests` directory. See existing files for examples.