Added package skeleton
Added modified version of thephpleague/skeleton as skeleton of package.
This commit is contained in:
@@ -0,0 +1,32 @@
|
||||
# Contributing
|
||||
|
||||
Contributions are **welcome** and will be fully **credited**.
|
||||
|
||||
We accept contributions via Pull Requests on [Github](https://github.com/yusufkandemir/microdata-parser).
|
||||
|
||||
|
||||
## Pull Requests
|
||||
|
||||
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - Check the code style with ``$ composer check-style`` and fix it with ``$ composer fix-style``.
|
||||
|
||||
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
|
||||
|
||||
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
|
||||
|
||||
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
|
||||
|
||||
- **Create feature branches** - Don't ask us to pull from your master branch.
|
||||
|
||||
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
|
||||
|
||||
- **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](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
|
||||
|
||||
|
||||
## Running Tests
|
||||
|
||||
``` bash
|
||||
$ composer test
|
||||
```
|
||||
|
||||
|
||||
**Happy coding**!
|
||||
@@ -0,0 +1,27 @@
|
||||
<!-- Provide a general summary of the issue in the Title above -->
|
||||
|
||||
## Detailed description
|
||||
|
||||
Provide a detailed description of the change or addition you are proposing.
|
||||
|
||||
Make it clear if the issue is a bug, an enhancement or just a question.
|
||||
|
||||
## Context
|
||||
|
||||
Why is this change important to you? How would you use it?
|
||||
|
||||
How can it benefit other users?
|
||||
|
||||
## Possible implementation
|
||||
|
||||
Not obligatory, but suggest an idea for implementing addition or change.
|
||||
|
||||
## Your environment
|
||||
|
||||
Include as many relevant details about the environment you experienced the bug in and how to reproduce it.
|
||||
|
||||
* Version used (e.g. PHP 7.2, HHVM 3):
|
||||
* Operating system and version (e.g. Ubuntu 16.04, Windows 10):
|
||||
* Link to your project:
|
||||
* ...
|
||||
* ...
|
||||
@@ -0,0 +1,43 @@
|
||||
<!--- Provide a general summary of your changes in the Title above -->
|
||||
|
||||
## Description
|
||||
|
||||
Describe your changes in detail.
|
||||
|
||||
## Motivation and context
|
||||
|
||||
Why is this change required? What problem does it solve?
|
||||
|
||||
If it fixes an open issue, please link to the issue here (if you write `fixes #num`
|
||||
or `closes #num`, the issue will be automatically closed when the pull is accepted.)
|
||||
|
||||
## How has this been tested?
|
||||
|
||||
Please describe in detail how you tested your changes.
|
||||
|
||||
Include details of your testing environment, and the tests you ran to
|
||||
see how your change affects other areas of the code, etc.
|
||||
|
||||
## Screenshots (if appropriate)
|
||||
|
||||
## Types of changes
|
||||
|
||||
What types of changes does your code introduce? Put an `x` in all the boxes that apply:
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||
- [ ] New feature (non-breaking change which adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
|
||||
|
||||
## Checklist:
|
||||
|
||||
Go over all the following points, and put an `x` in all the boxes that apply.
|
||||
|
||||
Please, please, please, don't send your pull request until all of the boxes are ticked. Once your pull request is created, it will trigger a build on our [continuous integration](http://www.phptherightway.com/#continuous-integration) server to make sure your [tests and code style pass](https://help.github.com/articles/about-required-status-checks/).
|
||||
|
||||
- [ ] I have read the **[CONTRIBUTING](CONTRIBUTING.md)** document.
|
||||
- [ ] My pull request addresses exactly one patch/feature.
|
||||
- [ ] I have created a branch for this patch/feature.
|
||||
- [ ] Each individual commit in the pull request is meaningful.
|
||||
- [ ] I have added tests to cover my changes.
|
||||
- [ ] If my change requires a change to the documentation, I have updated it accordingly.
|
||||
|
||||
If you're unsure about any of these, don't hesitate to ask. We're here to help!
|
||||
Reference in New Issue
Block a user