Plugin to allow visitor contributions to WordPress posts, wiki style.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

33 lines
1.2 KiB

  1. Contributing
  2. ============
  3. First of all, **thank you** for contributing, **you are awesome**!
  4. Here are a few rules to follow in order to ease code reviews, and discussions before
  5. maintainers accept and merge your work.
  6. You MUST follow the [PSR-1](http://www.php-fig.org/psr/1/) and
  7. [PSR-2](http://www.php-fig.org/psr/2/). If you don't know about any of them, you
  8. should really read the recommendations. Can't wait? Use the [PHP-CS-Fixer
  9. tool](http://cs.sensiolabs.org/).
  10. You MUST run the test suite.
  11. You MUST write (or update) unit tests.
  12. You SHOULD write documentation.
  13. Please, write [commit messages that make
  14. sense](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html),
  15. and [rebase your branch](http://git-scm.com/book/en/Git-Branching-Rebasing)
  16. before submitting your Pull Request.
  17. One may ask you to [squash your
  18. commits](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html)
  19. too. This is used to "clean" your Pull Request before merging it (we don't want
  20. commits such as `fix tests`, `fix 2`, `fix 3`, etc.).
  21. Also, while creating your Pull Request on GitHub, you MUST write a description
  22. which gives the context and/or explains why you are creating it.
  23. Thank you!