-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#2 Update README. Add docs, CHANGELOG & CONTRIBUTING.
- Loading branch information
1 parent
9ca5dab
commit e74fbfe
Showing
7 changed files
with
170 additions
and
2 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 |
---|---|---|
@@ -1,2 +1,9 @@ | ||
/composer.lock | ||
/vendor | ||
.env | ||
.idea | ||
/phpunit.xml | ||
.phpunit.result.cache | ||
.phpunit.cache | ||
.php-cs-fixer.cache | ||
coverage-report |
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,20 @@ | ||
v2.0 | ||
------ | ||
|
||
## BC breaks | ||
|
||
### Changes | ||
|
||
### Fixes | ||
|
||
v1.0.1 | ||
------ | ||
|
||
### Changes | ||
|
||
* Fixed dependencies after removing sidus/base-bundle from the base process bundle | ||
|
||
v1.0.0 | ||
------ | ||
|
||
* Initial release |
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,52 @@ | ||
Contributing | ||
============ | ||
|
||
First of all, **thank you** for contributing, **you are awesome**! | ||
|
||
Here are a few rules to follow in order to ease code reviews, and discussions before | ||
maintainers accept and merge your work. | ||
|
||
You MUST run the quality & test suites. | ||
|
||
You SHOULD write (or update) unit tests. | ||
|
||
You SHOULD write documentation. | ||
|
||
Please, write [commit messages that make sense](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html), | ||
and [rebase your branch](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) before submitting your Pull Request. | ||
|
||
One may ask you to [squash your commits](https://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) | ||
too. This is used to "clean" your Pull Request before merging it (we don't want | ||
commits such as `fix tests`, `fix 2`, `fix 3`, etc.). | ||
|
||
Thank you! | ||
|
||
## Running the quality & test suites | ||
|
||
Tests suite uses Docker environments in order to be idempotent to OS's. More than this | ||
PHP version is written inside the Dockerfile; this assures to test the bundle with | ||
the same resources. No need to have PHP installed. | ||
|
||
You only need Docker set it up. | ||
|
||
To allow testing environments more smooth we implemented **Makefile**. | ||
You have two commands available: | ||
|
||
```bash | ||
make quality | ||
``` | ||
|
||
```bash | ||
make tests | ||
``` | ||
|
||
## Deprecations notices | ||
|
||
When a feature should be deprecated, or when you have a breaking change for a future version, please : | ||
* [Fill an issue](https://github.com/cleverage/soap-process-bundle/issues/new) | ||
* Add TODO comments with the following format: `@TODO deprecated v2.0` | ||
* Trigger a deprecation error: `@trigger_error('This feature will be deprecated in v2.0', E_USER_DEPRECATED);` | ||
|
||
You can check which deprecation notice is triggered in tests | ||
* `make bash` | ||
* `SYMFONY_DEPRECATIONS_HELPER=0 ./vendor/bin/phpunit` |
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
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 |
---|---|---|
@@ -1,4 +1,22 @@ | ||
CleverAge/SoapProcessBundle | ||
======================= | ||
|
||
See process bundle documentation | ||
This bundle is a part of the [CleverAge/ProcessBundle](https://github.com/cleverage/process-bundle) project. | ||
It provides [Soap](https://fr.wikipedia.org/wiki/SOAP) integration on Process bundle. | ||
|
||
Compatible with [Symfony stable version and latest Long-Term Support (LTS) release](https://symfony.com/releases). | ||
|
||
## Documentation | ||
|
||
For usage documentation, see: | ||
[docs/index.md](doc/index.md) | ||
|
||
## Support & Contribution | ||
|
||
For general support and questions, please use [Github](https://github.com/cleverage/rest-process-bundle/issues). | ||
If you think you found a bug or you have a feature idea to propose, feel free to open an issue after looking at the [contributing](CONTRIBUTING.md) guide. | ||
|
||
## License | ||
|
||
This bundle is under the MIT license. | ||
For the whole copyright, see the [LICENSE](LICENSE) file distributed with this source code. |
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,27 @@ | ||
## Prerequisite | ||
|
||
CleverAge/ProcessBundle must be [installed](https://github.com/cleverage/process-bundle/blob/main/docs/01-quick_start.md#installation. | ||
|
||
## Installation | ||
|
||
Make sure Composer is installed globally, as explained in the [installation chapter](https://getcomposer.org/doc/00-intro.md) | ||
of the Composer documentation. | ||
|
||
Open a command console, enter your project directory and install it using composer: | ||
|
||
```bash | ||
composer require cleverage/soap-process-bundle | ||
``` | ||
|
||
Remember to add the following line to config/bundles.php (not required if Symfony Flex is used) | ||
|
||
```php | ||
CleverAge\SoapProcessBundle\CleverAgeSoapProcessBundle::class => ['all' => true], | ||
``` | ||
|
||
## Reference | ||
|
||
- Tasks | ||
- [RequestTask] | ||
- Transformers | ||
- [RequestTransformer] |
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,44 @@ | ||
TaskName | ||
======== | ||
|
||
_Describe main goal an use cases of the task_ | ||
|
||
Task reference | ||
-------------- | ||
|
||
* **Service**: `ClassName` | ||
|
||
Accepted inputs | ||
--------------- | ||
|
||
_Description of allowed types_ | ||
|
||
Possible outputs | ||
---------------- | ||
|
||
_Description of possible types_ | ||
|
||
Options | ||
------- | ||
|
||
| Code | Type | Required | Default | Description | | ||
| ---- | ---- | :------: | ------- | ----------- | | ||
| `code` | `type` | **X** _or nothing_ | `default value` _if available_ | _description_ | | ||
|
||
Examples | ||
-------- | ||
|
||
_YAML samples and explanations_ | ||
|
||
* Example 1 | ||
- details | ||
- details | ||
|
||
```yaml | ||
# Task configuration level | ||
code: | ||
service: '@service_ref' | ||
options: | ||
a: 1 | ||
b: 2 | ||
``` |