Added contributing and updated readme (keycloak#180)

CONTRIBUTING.md

@@ -0,0 +1,85 @@
+# Keycloak Community
+
+Keycloak is an Open Source Identity and Access Management solution for modern Applications and Services.
+
+## Contributing to Keycloak
+
+Keycloak is an Open Source community-driven project and we welcome contributions as well as feedback from the community.
+
+We do have a few guidelines in place to help you be successful with your contribution to Keycloak.
+
+Here's a quick checklist for a good PR, more details below:
+
+1. [Keycloak Dev Mailing List](https://lists.jboss.org/mailman/listinfo/keycloak-dev)
+2. A JIRA associated with the PR
+3. One feature/change per PR
+4. One commit per PR
+5. PR rebased on master (`git rebase`, not `git pull`) 
+5. Commit message is prefixed by JIRA number
+6. No changes to code not directly related to your PR
+7. Includes functional/integration test
+8. Includes documentation
+
+Once you have submitted your PR please monitor it for comments/feedback. We reserve the right to close inactive PRs if
+you do not respond within 2 weeks (bear in mind you can always open a new PR if it is closed due to inactivity).
+
+Also, please remember that we do receive a fairly large amount of PRs and also have code to write ourselves, so we may
+not be able to respond to your PR immediately. The best place to ping us is on the thread you started on the dev mailing list.
+
+### Finding something to work on
+
+If you would like to contribute to Keycloak, but are not sure exactly what to work on, you can find a number of open
+issues that are awaiting contributions in the 
+[Keycloak JIRA](https://issues.jboss.org/projects/KEYCLOAK/versions/12340167).
+
+### Open a discussion on Keycloak Dev Mailing List
+
+As Keycloak is a community-driven project we require contributors to send a description of what they are planning to 
+work on to the [Keycloak Dev Mailing List](https://lists.jboss.org/mailman/listinfo/keycloak-dev).
+
+We recommend starting the discussion prior to submitting your PR. Through the mailing list you can get valuable
+feedback both from the core Keycloak team as well as the wider community.
+
+### Create an issue in Keycloak JIRA
+
+Take your time to write a proper JIRA including a good summary and description. 
+
+Remember this may be the first thing a reviewer of your PR will look at to get an idea of what you are proposing 
+and it will also be used by the community in the future to find about what new features and enhancements are included in 
+new releases.
+
+Note: Keycloak Node.js Admin Client uses GitHub issues and not the Keycloak JIRA.
+
+### Implementing
+
+Do not format or refactor code that is not directly related to your contribution. If you do this it will significantly
+increase our effort in reviewing your PR. If you have a strong need to refactor code then submit a separate PR for the
+refactoring.
+
+### Testing
+
+There are currently no tests for the Docker images. Please make sure you verify changes properly and include a description
+of what you have tested in the PR description.
+
+### Documentation
+
+We require contributions to include relevant documentation. Include relevant changes to the image README.md file in
+your PR.
+
+### Submitting your PR
+
+When preparing your PR make sure you have a single commit and your branch is rebased on the master branch from the 
+project repository.
+
+This means use the `git rebase` command and not `git pull` when integrating changes from master to your branch. See
+[Git Documentation](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) for more details.
+
+We require that you squash to a single commit. You can do this with the `git rebase -i HEAD~X` command where X
+is the number of commits you want to squash. See the [Git Documentation](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History)
+for more details.
+
+The above helps us review your PR and also makes it easier for us to maintain the repository. It is also required by
+our automatic merging process. 
+
+We also require that the commit message is prefixed with the Keycloak JIRA issue number (example commit message 
+"KEYCLOAK-9876 My super cool new feature").

README.md

@@ -1,7 +1,58 @@
-# Keycloak Docker image
+# Keycloak
 
-This is a set of Docker images related to Keycloak. 
+Keycloak is an Open Source Identity and Access Management solution for modern Applications and Services.
 
-- [keycloak](https://registry.hub.docker.com/u/jboss/keycloak/) example Keycloak server
-- [keycloak-adapter-wildfly](https://registry.hub.docker.com/u/jboss/keycloak-adapter-wildfly/) builds on top of the [jboss/wildfly](https://registry.hub.docker.com/u/jboss/wildfly/) image, adding the Keycloak adapter for Wildfly to it, as well as the required changes to the standalone.xml
-- [keycloak-examples](https://registry.hub.docker.com/u/jboss/keycloak-examples/) builds on top of [keycloak](https://registry.hub.docker.com/u/jboss/keycloak/), adding the examples.
+This repository contains Docker images related to Keycloak.
+
+- [keycloak](https://cloud.docker.com/u/jboss/repository/docker/jboss/keycloak) Keycloak server
+* [gatekeeper](https://cloud.docker.com/u/keycloak/repository/docker/keycloak/keycloak-gatekeeper)
+- [keycloak-adapter-wildfly](https://cloud.docker.com/u/jboss/repository/docker/jboss/keycloak-adapter-wildfly) WildFly including Keycloak adapter
+
+
+## Help and Documentation
+
+* [Keycloak server image documentation](server/README.md)
+* [Documentation](https://www.keycloak.org/documentation.html)
+* [User Mailing List](https://lists.jboss.org/mailman/listinfo/keycloak-user) - Mailing list for help and general questions about Keycloak
+* [JIRA](https://issues.jboss.org/projects/KEYCLOAK) - Issue tracker for bugs and feature requests
+
+
+## Reporting Security Vulnerabilities
+
+If you've found a security vulnerability, please look at the [instructions on how to properly report it](http://www.keycloak.org/security.html)
+
+
+## Reporting an issue
+
+If you believe you have discovered a defect in Keycloak please open an issue in our [Issue Tracker](https://issues.jboss.org/projects/KEYCLOAK).
+Please remember to provide a good summary, description as well as steps to reproduce the issue.
+
+
+## Getting started
+
+To run Keycloak, run:
+
+    docker run jboss/keycloak
+
+For more details refer to the [Keycloak server image documentation](server/README.md).
+
+
+## Contributing
+
+Before contributing to Keycloak please read our [contributing guidelines](CONTRIBUTING.md).
+
+
+## Other Keycloak Projects
+
+* [Keycloak](https://github.com/keycloak/keycloak) - Keycloak Server and Java adapters
+* [Keycloak Documentation](https://github.com/keycloak/keycloak-documentation) - Documentation for Keycloak
+* [Keycloak QuickStarts](https://github.com/keycloak/keycloak-quickstarts) - QuickStarts for getting started with Keycloak
+* [Keycloak Docker](https://github.com/jboss-dockerfiles/keycloak) - Docker images for Keycloak
+* [Keycloak Gatekeeper](https://github.com/keycloak/keycloak-gatekeeper) - Proxy service to secure apps and services with Keycloak
+* [Keycloak Node.js Connect](https://github.com/keycloak/keycloak-nodejs-connect) - Node.js adapter for Keycloak
+* [Keycloak Node.js Admin Client](https://github.com/keycloak/keycloak-nodejs-admin-client) - Node.js library for Keycloak Admin REST API
+
+
+## License
+
+* [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)

docs/pull_request_template.md

@@ -0,0 +1,3 @@
+<!---
+Please read https://github.com/keycloak/keycloak/blob/master/CONTRIBUTING.md and follow these guidelines when contributing to Keycloak
+-->