Skip to content

Commit bc73517

Browse files
committed
chore: add license, changelog, contributing
1 parent 722a725 commit bc73517

File tree

3 files changed

+94
-0
lines changed

3 files changed

+94
-0
lines changed

CHANGELOG.md

Whitespace-only changes.

CONTRIBUTING.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
## How to contribute
2+
3+
### Before you start
4+
5+
<!-- This section contains conventions/standards contributors must follow -->
6+
<!-- For example: Commit messages should follow angular standard -->
7+
8+
### Setting up
9+
10+
You may need to fork this project in [GitHub](https://github.com/adhocore/php-cli-highlight).
11+
12+
```sh
13+
git clone git@github.com:adhocore/php-cli-highlight.git
14+
15+
# OR if you have a fork
16+
git clone git@github.com:<your_github_handle>/php-cli-highlight.git
17+
18+
# You may also add upstream
19+
git remote add upstream https://github.com/adhocore/php-cli-highlight.git
20+
21+
cd php-cli-highlight
22+
23+
# Create a new branch
24+
git checkout -b $branch_name
25+
26+
# Install deps
27+
composer install -o
28+
```
29+
30+
### Moving forward
31+
32+
```sh
33+
# Open php-cli-highlight in IDE
34+
subl php-cli-highlight
35+
36+
# ... and do the needful
37+
38+
# Optionally run the lint
39+
for P in src tests; do find $P -type f -name '*.php' -exec php -l {} \;; done
40+
41+
# ... and phpcs fixer or stuffs like that!
42+
43+
# Run tests
44+
vendor/bin/phpunit --coverage-text
45+
46+
47+
# If your feature takes long your dev branch might be out of sync, you may want to
48+
git checkout $branch_name
49+
git pull upstream master # branch could be something else than master
50+
```
51+
52+
### Finalizing
53+
54+
Everything looking good?
55+
56+
```sh
57+
# Commit your stuffs
58+
git add $file ...$files
59+
git commit -m "..."
60+
61+
# Push 'em
62+
git push origin HEAD
63+
```
64+
65+
Now goto [GitHub](https://github.com/adhocore/php-cli-highlight/compare?expand=1), select your branch and create PR.
66+
67+
### Getting PR merged
68+
69+
You have to wait. You have to address change requests. Be patient.
70+
71+
Thank you for contribution!
72+
73+
**Lastly** Please be informed that your works will be licensed same as the project [license](./LICENSE)

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2019 Jitendra Adhikari
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)