Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 2.74 KB
Raw

Contribution Guide

The Rampage PHP development team will review all issues and contributins submitted. Contributions can take the form of new components/features, changes to existing features, tests, documentation (such as developer guides, user guides, examples, or specifications), bug fixes, optimizations or just good suggestions. To assist in the expediency of the review process, we strongly encourage you to follow all the proper requirements stated below, before submitting any code for consideration.

Contributor License Agreement

All submissions you make to the Rampage PHP Framework (in short rampage.php or Rampage PHP) are subject to the following terms and conditions:

  • You grant a perpetual, worldwide, non-exclusive, no charge, royalty free, irrevocable license under your applicable copyrights and patents to reproduce, prepare derivative works of, display, publically perform, sublicense and distribute any feedback, ideas, code, or other information ("Submission") you submit.

  • All your contributions are fully compatible to or licensed under the terms of the General Public License Version 3, which can be viewed on http://www.gnu.org/licenses/gpl-3.0-standalone.html.

  • Your Submission is an original work of authorship and you are the owner or are legally entitled to grant the license stated above.

Contribution Process

If you are a new github user, we recommend that you create your own free github account. By doing that, you will be able to collaborate with the Rampage PHP development team, "fork" the project and be able to easily send “pull requests”.

  1. Search current listed issues (open or closed) for similar proposals of intended contribution before starting work on a new contribution.
  2. Review the Contributor License Agreement if this is your first time contributing.
  3. Create and test your work.
  4. Fork the Rampage PHP repository according to github's Fork A Repo instructions
  5. When you are ready to send us a Pull Request – follow github's Using Pull Requests instructions.
  6. Once your contribution is received, we will review the contribution and collaborate with you as needed to improve the quality of the contribution.

Contribution Acceptence Criteria

  • Code changes should be covered with automated tests and supplied along with the contribution. The author chooses the best approach for testing as deemed necessary.
  • New features or proposals must be supplied with documentation: functional (how a feature works) or technical (how it is implemented/designed), or both.
  • Your code must follow the PSR-4 coding style