-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add license, changelog, contributing
- Loading branch information
Showing
3 changed files
with
94 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
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,73 @@ | ||
## How to contribute | ||
|
||
### Before you start | ||
|
||
<!-- This section contains conventions/standards contributors must follow --> | ||
<!-- For example: Commit messages should follow angular standard --> | ||
|
||
### Setting up | ||
|
||
You may need to fork this project in [GitHub](https://github.com/adhocore/php-cli-highlight). | ||
|
||
```sh | ||
git clone git@github.com:adhocore/php-cli-highlight.git | ||
|
||
# OR if you have a fork | ||
git clone git@github.com:<your_github_handle>/php-cli-highlight.git | ||
|
||
# You may also add upstream | ||
git remote add upstream https://github.com/adhocore/php-cli-highlight.git | ||
|
||
cd php-cli-highlight | ||
|
||
# Create a new branch | ||
git checkout -b $branch_name | ||
|
||
# Install deps | ||
composer install -o | ||
``` | ||
|
||
### Moving forward | ||
|
||
```sh | ||
# Open php-cli-highlight in IDE | ||
subl php-cli-highlight | ||
|
||
# ... and do the needful | ||
|
||
# Optionally run the lint | ||
for P in src tests; do find $P -type f -name '*.php' -exec php -l {} \;; done | ||
|
||
# ... and phpcs fixer or stuffs like that! | ||
|
||
# Run tests | ||
vendor/bin/phpunit --coverage-text | ||
|
||
|
||
# If your feature takes long your dev branch might be out of sync, you may want to | ||
git checkout $branch_name | ||
git pull upstream master # branch could be something else than master | ||
``` | ||
|
||
### Finalizing | ||
|
||
Everything looking good? | ||
|
||
```sh | ||
# Commit your stuffs | ||
git add $file ...$files | ||
git commit -m "..." | ||
|
||
# Push 'em | ||
git push origin HEAD | ||
``` | ||
|
||
Now goto [GitHub](https://github.com/adhocore/php-cli-highlight/compare?expand=1), select your branch and create PR. | ||
|
||
### Getting PR merged | ||
|
||
You have to wait. You have to address change requests. Be patient. | ||
|
||
Thank you for contribution! | ||
|
||
**Lastly** Please be informed that your works will be licensed same as the project [license](./LICENSE) |
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 @@ | ||
MIT License | ||
|
||
Copyright (c) 2019 Jitendra Adhikari | ||
|
||
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. |