Skip to content

Commit

Permalink
feat: generate contributing.md [closes #36]
Browse files Browse the repository at this point in the history
  • Loading branch information
adhocore committed Aug 18, 2018
1 parent c772ba6 commit 7c31cab
Showing 1 changed file with 61 additions and 0 deletions.
61 changes: 61 additions & 0 deletions resources/CONTRIBUTING.md.twig
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.

0 comments on commit 7c31cab

Please sign in to comment.