Skip to content

Latest commit

 

History

History
20 lines (17 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

20 lines (17 loc) · 1.46 KB

Contributing

  • Maintenance on this module is a shared effort of those who use it
  • To contribute improvements to the code, ensure you raise a pull request and discuss with the module maintainers
  • Please follow the SilverStripe Module Standard
  • Supply documentation that follows the GitHub Flavored Markdown conventions

When contributing please follow the Issue and Pull Request templates provider to you.

Testing

  • This module uses PHPUnit for testing
  • To run the tests, run vendor/bin/phpunit from the root of a project that has this module installed
  • To run the tests with code coverage, run vendor/bin/phpunit --coverage-html=coverage from the root of a project that has this module installed

When contributing to the module, please write tests for all new functionality and ensure that all existing tests pass.

Contributor license agreement

By supplying code to this module in patches, tickets and pull requests, you agree to assign copyright of that code to Violet88., on the condition that these code changes are released under the same BSD license as the original module. We ask for this so that the ownership in the license is clear and unambiguous. By releasing this code under a permissive license such as BSD, this copyright assignment won't prevent you from using the code in any way you see fit.