From 5a1c4d3a128ce662301a80532a578f37f8d5c3c3 Mon Sep 17 00:00:00 2001
From: Sambhav Kothari <sambhavs.email@gmail.com>
Date: Thu, 12 Aug 2021 17:02:38 +0530
Subject: [PATCH] Gitpod-ify the repository (#548)

* Gitpod-ify the repository

* Update README.rst

* Create Makefile

* Update README.rst

* Update test.yml
---
 .github/workflows/test.yml |  2 +-
 .gitpod.yml                | 15 +++++++++++++++
 Makefile                   |  8 ++++++++
 README.rst                 | 16 +++++++++++++++-
 4 files changed, 39 insertions(+), 2 deletions(-)
 create mode 100644 .gitpod.yml
 create mode 100644 Makefile

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 1fdccd6e..a43d194f 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -19,4 +19,4 @@ jobs:
     - name: Install tox
       run: python -m pip install --upgrade pip tox
     - name: Run Tests
-      run: tox -e py,install,docs
+      run: make tests
diff --git a/.gitpod.yml b/.gitpod.yml
new file mode 100644
index 00000000..04ddeb44
--- /dev/null
+++ b/.gitpod.yml
@@ -0,0 +1,15 @@
+
+tasks:
+  - init: pip install -r requirements.txt && pip install -e .
+
+github:
+  prebuilds:
+    master: true
+    branches: true
+    pullRequests: true
+    pullRequestsFromForks: true
+    addCheck: true
+
+vscode:
+  extensions:
+    - ms-python.python
diff --git a/Makefile b/Makefile
new file mode 100644
index 00000000..5598adcb
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,8 @@
+all: format tests
+
+format:
+	isort src/pydocstyle
+	black src/pydocstyle
+
+tests:
+	tox -e py,install,docs
diff --git a/README.rst b/README.rst
index a4e8aa7a..3eb30951 100644
--- a/README.rst
+++ b/README.rst
@@ -21,6 +21,10 @@ pydocstyle - docstring style checker
 .. image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
     :target: https://pycqa.github.io/isort/
 
+.. image:: https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod
+    :target: https://gitpod.io/#https://github.com/PyCQA/pydocstyle
+    :alt: Gitpod ready-to-code
+
 **pydocstyle** is a static analysis tool for checking compliance with Python
 docstring conventions.
 
@@ -43,7 +47,7 @@ Install
 
 
 Run
-^^^^
+^^^
 
 .. code::
 
@@ -56,6 +60,16 @@ Run
         D201: No blank lines allowed before function docstring (found 1)
     ...
 
+Develop
+^^^^^^^
+
+You can use Gitpod to run pre-configured dev envrionment in the cloud right from your browser -
+
+.. image:: https://gitpod.io/button/open-in-gitpod.svg
+    :target: https://gitpod.io/#https://github.com/PyCQA/pydocstyle
+    :alt: Open in Gitpod
+    
+Before submitting a PR make sure that you run `make all`.
 
 Links
 -----