adulau/cakephp2-php8
1
0
Fork 0
mirror of https://github.com/kamilwylegala/cakephp2-php8.git synced 2024-11-30 02:37:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Changed to UNIX line ending

Browse source
This commit is contained in:
ADmad 2013-10-30 02:27:49 +05:30
parent f700ac0909
commit 93cd458144
1 changed files with 73 additions and 73 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

146
CONTRIBUTING.md
View file

@ -1,73 +1,73 @@
# How to contribute # How to contribute
CakePHP loves to welcome your contributions. There are several ways to help out: CakePHP loves to welcome your contributions. There are several ways to help out:
* Create an [issue](https://github.com/cakephp/cakephp/issues) on GitHub, if you have found a bug * Create an [issue](https://github.com/cakephp/cakephp/issues) on GitHub, if you have found a bug
* Write testcases for open bug issues * Write testcases for open bug issues
* Write patches for open bug/feature issues, preferably with testcases included * Write patches for open bug/feature issues, preferably with testcases included
* Contribute to the [documentation](https://github.com/cakephp/docs) * Contribute to the [documentation](https://github.com/cakephp/docs)
There are a few guidelines that we need contributors to follow so that we have a There are a few guidelines that we need contributors to follow so that we have a
chance of keeping on top of things. chance of keeping on top of things.
## Getting Started ## Getting Started
* Make sure you have a [GitHub account](https://github.com/signup/free). * Make sure you have a [GitHub account](https://github.com/signup/free).
* Submit an [issue](https://github.com/cakephp/cakephp/issues), assuming one does not already exist. * Submit an [issue](https://github.com/cakephp/cakephp/issues), assuming one does not already exist.
* Clearly describe the issue including steps to reproduce when it is a bug. * Clearly describe the issue including steps to reproduce when it is a bug.
* Make sure you fill in the earliest version that you know has the issue. * Make sure you fill in the earliest version that you know has the issue.
* Fork the repository on GitHub. * Fork the repository on GitHub.
## Making Changes ## Making Changes
* Create a topic branch from where you want to base your work. * Create a topic branch from where you want to base your work.
* This is usually the master branch. * This is usually the master branch.
* Only target release branches if you are certain your fix must be on that * Only target release branches if you are certain your fix must be on that
branch. branch.
* To quickly create a topic branch based on master; `git branch * To quickly create a topic branch based on master; `git branch
master/my_contribution master` then checkout the new branch with `git master/my_contribution master` then checkout the new branch with `git
checkout master/my_contribution`. Better avoid working directly on the checkout master/my_contribution`. Better avoid working directly on the
`master` branch, to avoid conflicts if you pull in updates from origin. `master` branch, to avoid conflicts if you pull in updates from origin.
* Make commits of logical units. * Make commits of logical units.
* Check for unnecessary whitespace with `git diff --check` before committing. * Check for unnecessary whitespace with `git diff --check` before committing.
* Use descriptive commit messages and reference the #issue number. * Use descriptive commit messages and reference the #issue number.
* Core testcases should continue to pass. You can run tests locally or enable * Core testcases should continue to pass. You can run tests locally or enable
[travis-ci](https://travis-ci.org/) for your fork, so all tests and codesniffs [travis-ci](https://travis-ci.org/) for your fork, so all tests and codesniffs
will be executed. will be executed.
* Your work should apply the CakePHP coding standards. * Your work should apply the CakePHP coding standards.
## Which branch to base the work ## Which branch to base the work
* Bugfix branches will be based on master. * Bugfix branches will be based on master.
* New features that are backwards compatible will be based on next minor release * New features that are backwards compatible will be based on next minor release
branch. branch.
* New features or other non-BC changes will go in the next major release branch. * New features or other non-BC changes will go in the next major release branch.
## Submitting Changes ## Submitting Changes
* Push your changes to a topic branch in your fork of the repository. * Push your changes to a topic branch in your fork of the repository.
* Submit a pull request to the repository in the cakephp organization, with the * Submit a pull request to the repository in the cakephp organization, with the
correct target branch. correct target branch.
## Testcases and codesniffer ## Testcases and codesniffer
CakePHP tests requires [PHPUnit](http://www.phpunit.de/manual/current/en/installation.html) CakePHP tests requires [PHPUnit](http://www.phpunit.de/manual/current/en/installation.html)
3.5 or higher. To run the testcases locally use the following command: 3.5 or higher. To run the testcases locally use the following command:
./lib/Cake/Console/cake test core AllTests --stderr ./lib/Cake/Console/cake test core AllTests --stderr
To run the sniffs for CakePHP coding standards: To run the sniffs for CakePHP coding standards:
phpcs -p --extensions=php --standard=CakePHP ./lib/Cake phpcs -p --extensions=php --standard=CakePHP ./lib/Cake
Check the [cakephp-codesniffer](https://github.com/cakephp/cakephp-codesniffer) Check the [cakephp-codesniffer](https://github.com/cakephp/cakephp-codesniffer)
repository to setup the CakePHP standard. The README contains installation info repository to setup the CakePHP standard. The README contains installation info
for the sniff and phpcs. for the sniff and phpcs.
# Additional Resources # Additional Resources
* [CakePHP coding standards](http://book.cakephp.org/2.0/en/contributing/cakephp-coding-conventions.html) * [CakePHP coding standards](http://book.cakephp.org/2.0/en/contributing/cakephp-coding-conventions.html)
* [Existing issues](https://github.com/cakephp/cakephp/issues) * [Existing issues](https://github.com/cakephp/cakephp/issues)
* [General GitHub documentation](https://help.github.com/) * [General GitHub documentation](https://help.github.com/)
* [GitHub pull request documentation](https://help.github.com/send-pull-requests/) * [GitHub pull request documentation](https://help.github.com/send-pull-requests/)
* #cakephp IRC channel on freenode.org * #cakephp IRC channel on freenode.org