Skip to content

Commit

Permalink
Adds github templates, moves contribution guide to .github
Browse files Browse the repository at this point in the history
  • Loading branch information
Holger Woltersdorf committed Jan 3, 2018
1 parent c007824 commit da11632
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 4 deletions.
18 changes: 14 additions & 4 deletions CONTRIBUTING.md → .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@

Contributions are **welcome** and will be fully **credited**.

We accept contributions via pull requests on [GitHub](https://github.com/icehawk/static-page-generator).
We accept contributions via pull requests on [GitHub](http://github.com/icehawk/static-page-generator).

## Issues

- Please report issues here on [GitHub](http://github.com/icehawk/static-page-generator/issues)

## Pull Requests

- **Add tests!** - Your patch will not be accepted if it does not have tests.

- **Document any change in behaviour** - Make sure the documentation in `README.md` is kept up-to-date.
- **Document any change in behaviour** - Make sure the documentation in `README.md` and the `CHANGELOG.md` is kept up-to-date.

- **Consider our release cycle** - We follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.

Expand All @@ -20,6 +23,13 @@ We accept contributions via pull requests on [GitHub](https://github.com/icehawk
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.


## Running Tests
## Run the tests

```bash
$ composer update
$ php vendor/bin/phpunit.phar -c build/
```

---

$ vendor/bin/phpunit -c build/
Thanks for your help!
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## Expected Behavior


## Actual Behavior


## Steps to Reproduce the Problem

1.
2.
3.

## Specifications

- Package version:
- PHP version:
- Platform/OS:
- Subsystem:

## Further comments
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Fixes #`<issue-number>`

## Proposed Changes

-
-
-

## Further comments

0 comments on commit da11632

Please sign in to comment.