DMOH-18: Added basic module structure.

.gitignore

@@ -1,36 +1,5 @@
-# Ignore configuration files that may contain sensitive information.
-sites/*/*settings*.php
+# Ignore the module lock file.
+/composer.lock
 
-# Ignore paths that contain generated content.
-files/
-sites/*/files
-sites/*/private
-
-# Ignore default text files
-robots.txt
-/CHANGELOG.txt
-/COPYRIGHT.txt
-/INSTALL*.txt
-/LICENSE.txt
-/MAINTAINERS.txt
-/UPGRADE.txt
-/README.txt
-sites/README.txt
-sites/all/modules/README.txt
-sites/all/themes/README.txt
-
-# Ignore everything but the "sites" folder ( for non core developer )
-.htaccess
-web.config
-authorize.php
-cron.php
-index.php
-install.php
-update.php
-xmlrpc.php
-/includes
-/misc
-/modules
-/profiles
-/scripts
-/themes
+# Ignore the vendor directory.
+/vendor

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+All Notable changes to `drupal/opening-hours` module.
+
+## [Unreleased]
+
+### Added
+
+[Unreleased]: https://github.com/StadGent/drupal_module_opening-hours/compare/master...develop

CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# Contributor Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language.
+* Being respectful of differing viewpoints and experiences.
+* Gracefully accepting constructive criticism.
+* Focusing on what is best for the community.
+* Showing empathy towards other community members.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances.
+* Trolling, insulting/derogatory comments, and personal or political attacks.
+* Public or private harassment.
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission.
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting.
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at `:author_email`. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at
+[http://contributor-covenant.org/version/1/4][version].
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,54 @@
+# Contributing to this project
+
+1. [Contributing](#contributing)
+1. [Submitting an Issue](#issues)
+1. [Submitting a Pull Request](#pull-requests)
+
+## Contributing
+
+Thank you for your interest in contributing to this project. There are several
+ways to help out, even if you've never worked on an open source project before.
+
+* If you've found a bug or want to request a feature, you can report it by
+  [posting an issue] - be sure to read the [guidelines](#issues) first!
+* If you want to contribute your own work (be it code or documentation), please
+  read the [guidelines](#pull-requests) for submitting a pull request.
+* **If you want to report a security issue, please read
+  [the Security guidelines](SECURITY.md) first!**
+
+## Issues
+
+Issues are intended for reporting bugs and weird behaviour or suggesting
+improvements to this project.
+
+Before you submit an issue, please go through the following checklist:
+
+* **FILL IN ALL THE FIELDS ASKED FOR**
+* Search through existing issues (*including closed issues!*) first: you might
+  be able to get your answer there.
+* Double check your issue manually, because it could be an external issue.
+* What providers are you using?
+* If you post logs, please use pastebin or github gist to store them!
+* Give a short step by step of how to reproduce the error.
+* What browser are you using and on which OS if it's a front-end issue.
+* Which system is this project deployed on if it's an application error.
+
+The more relevant information you provide, the more likely that your issue will
+be resolved.
+
+## Pull Requests
+
+Pull requests are intended for contributing code or documentation to the
+project.
+
+Before you submit a pull request, consider the following:
+
+* Make sure your pull request is made for the *8.x-dev* branch (or relevant
+  feature branch).
+* Have you tested your PR? If not, why?
+* Does your PR have any limitations we should know of?
+* Is your PR up-to-date with the branch you're trying to push into?
+* Is your code in check with the [Drupal Coding Standards].
+
+[posting an issue]: https://github.com/StadGent/php_package_services-opening-hours/issues/new
+[Drupal Coding Standards]: https://www.drupal.org/docs/develop/standards

README.md

@@ -1,2 +1,80 @@
-# drupal_module_opening-hours
-Drupal module that integrates the Opening Hours platform functionality.
+# Drupal 8 : Opening Hours module
+
+[![License][ico-license]][link-license]
+
+Drupal 8 module that integrates the Opening Hours platform functionality.
+
+This module allows to consume the [Opening Hours Platform] API to lookup
+services, their channels and their opening hours data.
+
+## Install
+
+Install using composer:
+
+Add the git source to the composer by editing the `composer.json` in the project
+root and add following lines in the `repositories section:
+
+```json
+        {
+            "type": "vcs",
+            "url": "git@github.com:StadGent/drupal_module_opening-hours.git"
+        }
+```
+
+Install the module using composer:
+
+```bash
+composer require drupal/opening-hours
+```
+
+## Usage
+
+> TODO!
+
+## Change log
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed
+recently.
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md)
+and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
+
+## Security
+
+If you discover any security related issues, please email security [at] gent.be
+instead of using the issue tracker. See [SECURITY](SECURITY.md)
+
+## Credits
+
+- [Stad Gent][link-author-stadgent]
+- [Digipolis Gent][link-author-digipolisgent]
+- [All Contributors][link-contributors]
+
+## License
+
+The MIT License (MIT). Please see [License File][link-license] for more
+information.
+
+## Roadmap and issue queue notes
+
+This project is created and maintained by Digipolis Gent. During active
+development, we use an internal issue tracker to guide/drive our development.
+By working this way, we can link issues for other projects dependent on this
+project, create cross-project boards, ... This allows our developers, project
+leads and business analysts to have a better overview than we can create on
+Github. This means that our roadmap won't be visible on here (for now).
+
+We still look at the issue queue here and off course we welcome pull requests
+with open arms! We are committed to creating and maintaining open source
+projects. Questions about our approach can be asked through the issue queue
+(except for security issues).
+
+[ico-license]: https://img.shields.io/github/license/StadGent/drupal_module_opening-hours.svg?style=flat-square
+
+[link-license]: LICENSE.md
+[link-author-stadgent]: https://github.com/stadgent
+[link-author-digipolisgent]: https://github.com/digipolisgent
+[link-contributors]: ../../contributors
+[Opening Hours platform]: https://github.com/StadGent/laravel_site_opening-hours

SECURITY.md

@@ -0,0 +1,48 @@
+# Security Issues
+
+This document explains how security issues are handled by the team that
+maintains this project.
+
+## Reporting a Security Issue
+
+If you think that you have found a security issue in this project, do **not**
+use the issue tracker and do **not** publish it publicly. Instead, all security
+issues must be sent to security [at] gent.be.
+
+## Resolving Process
+
+For each report, we first try to confirm the vulnerability. When it is
+confirmed, we will work on a solution following these steps:
+
+* Send an acknowledgement to the reporter.
+* Work on a patch.
+* Write a security announcement for this repository about the vulnerability.
+  This will be posted as a wiki page and referenced from this file.
+  It will contain at least the following:
+  * A title that always include the "Security release" string.
+  * A description of the vulnerability.
+  * The affected versions.
+  * The possible exploits.
+  * How to patch/upgrade/workaround affected applications.
+  * The CVE identifier.
+  * Credits.
+* Send the patch and the announcement to the reporter for review.
+* Apply the patch to this project and release a new version.
+* Publish the wiki page on this repository.
+* Update the security advisory list (see below).
+
+> Releases that include security issues should not be done on Saturday or
+> Sunday, except if the vulnerability has been publicly posted.
+>
+> While we are working on a patch, please do not reveal the issue publicly.
+>
+> The resolution takes anywhere between a couple of days to a month depending
+> on its complexity and the coordination with the downstream projects (see next
+> paragraph).
+
+## Security Advisories
+
+This section indexes security vulnerabilities that were fixed in releases for
+this project.
+
+### 1.0.0

composer.json

@@ -0,0 +1,40 @@
+{
+  "name": "drupal/opening-hours",
+  "type": "drupal-module",
+  "description": "Integrates the Opening Hours platform functionality.",
+  "keywords": ["Drupal", "gent", "services", "opening hours"],
+  "license": "GPL-2.0+",
+  "homepage": "https://github.com/StadGent/drupal_module_opening-hours",
+  "minimum-stability": "dev",
+  "prefer-stable": true,
+  "authors": [
+    {
+      "name": "Peter Decuyper",
+      "email": "peter.decuyper@digipolis.gent"
+    }
+  ],
+  "support": {
+    "issues": "https://github.com/StadGent/drupal_module_opening-hours/issues",
+    "source": "https://github.com/StadGent/drupal_module_opening-hours"
+  },
+  "require": {
+    "stadgent/services-opening-hours": "^0.1.0"
+  },
+  "require-dev": {
+    "brainmaestro/composer-git-hooks": "^2.4",
+    "drupal/coder": "~8.2"
+  },
+  "scripts": {
+    "check-style": [
+      "vendor/bin/phpcs"
+    ],
+    "post-install-cmd": [
+      "vendor/bin/cghooks update"
+    ]
+  },
+  "hooks": {
+    "pre-commit": [
+      "vendor/bin/phpcs"
+    ]
+  }
+}

phpcs-ruleset.xml.dist

@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<!-- PHP_CodeSniffer standard for Drupal modules. -->
+<!-- See http://pear.php.net/manual/en/package.php.php-codesniffer.annotated-ruleset.php -->
+<ruleset name="Drupal Module">
+    <description>Drupal coding standard for contributed modules</description>
+
+    <!-- Exclude unsupported file types. -->
+    <exclude-pattern>*.gif</exclude-pattern>
+    <exclude-pattern>*.less</exclude-pattern>
+    <exclude-pattern>*.png</exclude-pattern>
+
+    <!-- Minified files don't have to comply with coding standards. -->
+    <exclude-pattern>*.min.css</exclude-pattern>
+    <exclude-pattern>*.min.js</exclude-pattern>
+
+    <rule ref="./vendor/drupal/coder/coder_sniffer/Drupal" />
+</ruleset>

phpcs.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset name="pbm_default">
+    <description>Default PHP CodeSniffer configuration for Organic Groups.</description>
+    <rule ref="phpcs-ruleset.xml.dist"/>
+    <arg name="extensions" value="php,inc,module,install,info,test,profile,theme,css,js"/>
+    <arg name="report" value="full"/>
+    <arg value="p"/>
+    <file>.</file>
+    <exclude-pattern>./vendor</exclude-pattern>
+    <exclude-pattern>*.md</exclude-pattern>
+</ruleset>