-
Notifications
You must be signed in to change notification settings - Fork 64
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9741e90
commit a3fa012
Showing
7 changed files
with
203 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
; This file is for unifying the coding style for different editors and IDEs. | ||
; More information at http://editorconfig.org | ||
|
||
root = false | ||
|
||
[*] | ||
indent_style = tab | ||
indent_size = 2 | ||
charset = "utf-8" | ||
end_of_line = lf | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
|
||
[*.yml] | ||
indent_style = space | ||
indent_size = 2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
:major: 1 | ||
:minor: 0 | ||
:patch: 0 | ||
:special: '' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
# How to contribute | ||
|
||
CsvView loves to welcome your contributions. There are several ways to help out: | ||
* Create a ticket in GitHub, if you have found a bug | ||
* Write testcases for open bug tickets | ||
* Write patches for open bug/feature tickets, preferably with testcases included | ||
* Contribute to the [documentation](https://github.com/josegonzalez/cakephp-csvview/tree/gh-pages) | ||
|
||
There are a few guidelines that we need contributors to follow so that we have a | ||
chance of keeping on top of things. | ||
|
||
## Getting Started | ||
|
||
* Make sure you have a [GitHub account](https://github.com/signup/free) | ||
* Submit a ticket for your issue, assuming one does not already exist. | ||
* 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. | ||
* Fork the repository on GitHub. | ||
|
||
## Making Changes | ||
|
||
* Create a topic branch from where you want to base your work. | ||
* This is usually the develop branch | ||
* To quickly create a topic branch based on master; `git branch | ||
master/my_contribution master` then checkout the new branch with `git | ||
checkout master/my_contribution`. Better avoid working directly on the | ||
`master` branch, to avoid conflicts if you pull in updates from origin. | ||
* Make commits of logical units. | ||
* Check for unnecessary whitespace with `git diff --check` before committing. | ||
* Use descriptive commit messages and reference the #ticket number | ||
* 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 | ||
will be executed. | ||
* Your work should apply the CakePHP coding standards. | ||
|
||
## Which branch to base the work | ||
|
||
* Bugfix branches will be based on develop branch. | ||
* New features that are backwards compatible will be based on develop branch | ||
* New features or other non-BC changes will go in the next major release branch. | ||
|
||
## Submitting Changes | ||
|
||
* Push your changes to a topic branch in your fork of the repository. | ||
* Submit a pull request to the repository with the correct target branch. | ||
|
||
## Testcases and codesniffer | ||
|
||
CsvView 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: | ||
|
||
./lib/Cake/Console/cake test CsvView AllCsvView | ||
|
||
To run the sniffs for CakePHP coding standards | ||
|
||
phpcs -p --extensions=php --standard=CakePHP ./app/Plugin/CsvView | ||
|
||
Check the [cakephp-codesniffer](https://github.com/cakephp/cakephp-codesniffer) | ||
repository to setup the CakePHP standard. The README contains installation info | ||
for the sniff and phpcs. | ||
|
||
|
||
# Additional Resources | ||
|
||
* [CakePHP coding standards](http://book.cakephp.org/2.0/en/contributing/cakephp-coding-conventions.html) | ||
* [Bug tracker](https://github.com/josegonzalez/cakephp-csvview/issues) | ||
* [General GitHub documentation](https://help.github.com/) | ||
* [GitHub pull request documentation](https://help.github.com/send-pull-requests/) | ||
* #cakephp IRC channel on freenode.org |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2012 Jose Diaz-Gonzalez | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,58 @@ | ||
{ | ||
"name": "josegonzalez/CsvView", | ||
"name": "josegonzalez/cakephp-csvview", | ||
"version": "1.0.0", | ||
"description": "A CSV View class for CakePHP 2.x", | ||
"type": "cakephp-plugin", | ||
"description": "A CSV View class for CakePHP 2.x", | ||
"homepage": "http://github.com/josegonzalez/CsvView", | ||
"keywords": [ | ||
"cakephp", | ||
"csv", | ||
"view", | ||
"export" | ||
], | ||
"homepage": "http://github.com/josegonzalez/cakephp-csvview", | ||
"license": "MIT", | ||
"authors": [ | ||
{ | ||
"name": "Jose Gonzalez", | ||
"email": "[email protected]", | ||
"homepage": "http://josediazgonzalez.com", | ||
"role": "Maintainer" | ||
}, | ||
{ | ||
"name":"ADmad", | ||
"role":"Contributor", | ||
"homepage":"https://github.com/admad" | ||
}, | ||
{ | ||
"name":"Mark Scherer", | ||
"role":"Contributor", | ||
"homepage":"https://github.com/dereuromark" | ||
}, | ||
{ | ||
"name":"Joshua Paling", | ||
"role":"Contributor", | ||
"homepage":"https://github.com/joshuapaling" | ||
}, | ||
{ | ||
"name":"Gaurish Sharma", | ||
"role":"Contributor", | ||
"homepage":"https://github.com/gaurish" | ||
}, | ||
{ | ||
"name":"Gregory Gaskill", | ||
"role":"Contributor", | ||
"homepage":"https://github.com/chronon" | ||
} | ||
], | ||
"require": { | ||
"php": ">=5.3.0", | ||
"composer/installers": "*" | ||
}, | ||
"support": { | ||
"email": "[email protected]", | ||
"issues": "https://github.com/josegonzalez/cakephp-csvview/issues", | ||
"source": "https://github.com/josegonzalez/cakephp-csvview" | ||
}, | ||
"extra": { | ||
"installer-name": "CsvView" | ||
} | ||
} |