-
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: generate contributing.md [closes #36]
- Loading branch information
Showing
1 changed file
with
61 additions
and
0 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,61 @@ | ||
## 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/{{username}}/{{project}}). | ||
|
||
```sh | ||
git clone git@github.com:{{username}}/{{project}}.git | ||
|
||
# OR if you have a fork | ||
# git clone git@github.com:<your_github_handle>/{{project}}.git | ||
|
||
cd {{project}} | ||
|
||
# Create a new branch | ||
git checkout -b $branch_name | ||
|
||
# Install deps | ||
composer install -o | ||
``` | ||
|
||
### Moving forward | ||
|
||
```sh | ||
# Open {{project}} in IDE | ||
subl {{project}} | ||
|
||
# ... 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 | ||
``` | ||
|
||
### 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/{{username}}/{{project}}/compare?expand=1), select your branch and create PR. | ||
|
||
### Getting PR merged | ||
|
||
You have to wait. You have to address change requests. |