Skip to content

Commit

Permalink
Add ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
NicolasGuilloux committed Jul 20, 2021
1 parent 9fe2f89 commit 1985957
Show file tree
Hide file tree
Showing 4 changed files with 107 additions and 91 deletions.
105 changes: 105 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@

ifdef::env-github[]
++++
<p align="center">
<img src="./.github/logo.svg">
</p>
++++
endif::[]

ifndef::env-github[]
image:.github/logo.svg[Logo, align=center]
endif::[]

image:https://img.shields.io/packagist/v/rich-id/terms-module-bundle[link="https://packagist.org/packages/rich-id/terms-module-bundle",window="_blank"]
image:https://github.com/rich-id/terms-module/workflows/Tests/badge.svg[link="https://github.com/rich-id/terms-module/actions",window="_blank"]
image:https://coveralls.io/repos/github/rich-id/terms-module/badge.svg?branch=master[link="https://coveralls.io/github/rich-id/terms-module?branch=master",window="_blank"]
image:https://api.codeclimate.com/v1/badges/af5513a99208495d8c40/maintainability[link="https://codeclimate.com/github/rich-id/terms-module/maintainability",window="_blank"]
image:https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat[link="https://github.com/richcongress/test-suite/issues",window="_blank"]
image:https://img.shields.io/badge/license-MIT-blue.svg[link="LICENSE.md",window="_blank"]
image:https://img.shields.io/badge/PHP-7.3%2B-yellow[]
image:https://img.shields.io/badge/Symfony-4%2B-black[]
image:https://img.shields.io/badge/Symfony-5%2B-black[]


A module to quickly implement a terms approvals voter with terms version support.


== Quick showcase

Quick showcase

== Table of content

<<1. Installation>> +
<<2. Documentation>> +
<<3. Examples>> +
<<4. Versioning>> +
<<5. Contributing>> +
<<6. License>> +
<<7. Hacking>> +


== 1. Installation

This version of the bundle requires Symfony 4.4+ and PHP 7.3+.

[source,bash]
----
composer require rich-id/terms-module-bundle
----


== 2. Documentation



== 3. Examples


== 4. Versioning

terms-module-bundle follows link:https://semver.org/[semantic versioning^]. In short the scheme is MAJOR.MINOR.PATCH where
1. MAJOR is bumped when there is a breaking change,
2. MINOR is bumped when a new feature is added in a backward-compatible way,
3. PATCH is bumped when a bug is fixed in a backward-compatible way.

Versions bellow 1.0.0 are considered experimental and breaking changes may occur at any time.


== 5. Contributing

Contributions are welcomed! There are many ways to contribute, and we appreciate all of them. Here are some of the major ones:

* link:https://github.com/rich-id/terms-module/issues[Bug Reports^]: While we strive for quality software, bugs can happen, and we can't fix issues we're not aware of. So please report even if you're not sure about it or just want to ask a question. If anything the issue might indicate that the documentation can still be improved!
* link:https://github.com/rich-id/terms-module/issues[Feature Request^]: You have a use case not covered by the current api? Want to suggest a change or add something? We'd be glad to read about it and start a discussion to try to find the best possible solution.
* link:https://github.com/rich-id/terms-module/pulls[Pull Request^]: Want to contribute code or documentation? We'd love that! If you need help to get started, GitHub as link:https://help.github.com/articles/about-pull-requests/[documentation^] on pull requests. We use the link:https://help.github.com/articles/about-collaborative-development-models/["fork and pull model"^] were contributors push changes to their personal fork and then create pull requests to the main repository. Please make your pull requests against the `master` branch.

As a reminder, all contributors are expected to follow our [Code of Conduct](CODE_OF_CONDUCT.md).


== 6. License

test-suite is distributed under the terms of the MIT license.

See link:./LICENSE[LICENSE^] for details.


== 7. Hacking

You might use Docker and `docker-compose` to hack the project. Check out the following commands.

[source,bash]
----
# Start the project
docker-compose up -d
# Install dependencies
docker-compose exec application composer install
# Run tests
docker-compose exec application bin/phpunit
# Run a bash within the container
docker-compose exec application bash
----
88 changes: 0 additions & 88 deletions README.md

This file was deleted.

1 change: 0 additions & 1 deletion src/Infrastructure/DependencyInjection/Configuration.php
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
namespace RichId\TermsModuleBundle\Infrastructure\DependencyInjection;

use RichCongress\BundleToolbox\Configuration\AbstractConfiguration;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\NodeBuilder;

class Configuration extends AbstractConfiguration
Expand Down
4 changes: 2 additions & 2 deletions src/UserInterface/Controller/SignRoute.php
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,11 @@ protected function getSubject(Request $request): TermsSubjectInterface
$subjectType = $request->query->get('type');
$subjectIdentifier = $request->query->get('identifier');

if (!is_string($subjectType) || $subjectType === '') {
if (!\is_string($subjectType) || $subjectType === '') {
throw new BadRequestHttpException('Query parameter type is missing.');
}

if (!is_string($subjectIdentifier) || $subjectIdentifier === '') {
if (!\is_string($subjectIdentifier) || $subjectIdentifier === '') {
throw new BadRequestHttpException('Query parameter identifier is missing.');
}

Expand Down

0 comments on commit 1985957

Please sign in to comment.