Skip to content

Latest commit

 

History

History
22 lines (13 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

22 lines (13 loc) · 2.58 KB

Contributing to Seme Framework

Seme Framework created not to make you confused, but if you need OFF ROAD way Seme Framework is your answer.

If you have any ideas, every contribution is welcome; either by reporting a bug or suggesting improvements, or in a more active form like requesting a pull.

We want to create lightweight PHP MVC Framework. Thus, below are some guidelines that we expect to be followed by each contributor:

  • Be brief, but be bold. State your issues briefly. But speak out your ideas loudly, even if you can't or don't know how to implement them right away. The world will be better with limitless innovations.
  • Follow PHP-FIG standards. We follow PHP Standards Recommendations (PSRs) by PHP Framework Interoperability Group. If you're not familiar with these standards, familiarize yourself now. Also, please run composer fix to automatically fix your code to match these recommendations.
  • Test your code. No one knows your code better than you, so we depend on you to test the changes you make before pull request submission. We use PHPUnit for our testing purposes and request that you use this tool too. Tests can be ran with composer test. Documentation for writing tests with PHPUnit is available on Read the Docs.
  • Use best practices when submitting pull requests. Create a separate branch named specifically for the issue that you are addressing. Read the GitHub manual to learn more about pull requests and GitHub. If you are new to GitHub, read this short manual to get yourself familiar with forks and how git works in general. This video explains how to synchronize your fork on GitHub with the upstream branch from PHPWord.

Getting Started

Clone SemeFramework

You're ready to start working on!

When you're ready to submit your new (and fully tested) feature submit a pull request to SemeFramework.

That's it. Thank you for your interest in SemeFramework, and welcome!