GitBook: [master] 16 pages modified

.github/README.md

@@ -0,0 +1,2 @@
+# .github
+

.github/issue_template/README.md

@@ -0,0 +1,2 @@
+# ISSUE\_TEMPLATE
+

.github/issue_template/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+---
+
+# bug\_report
+
+**Describe the bug** A clear and concise description of what the bug is.
+
+**To Reproduce** Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error
+
+**Expected behavior** A clear and concise description of what you expected to happen.
+
+**Screenshots** If applicable, add screenshots to help explain your problem.
+
+**Desktop \(please complete the following information\):**
+
+* OS: \[e.g. iOS\]
+* Browser \[e.g. chrome, safari\]
+* Version \[e.g. 22\]
+
+**Smartphone \(please complete the following information\):**
+
+* Device: \[e.g. iPhone6\]
+* OS: \[e.g. iOS8.1\]
+* Browser \[e.g. stock browser, safari\]
+* Version \[e.g. 22\]
+
+**Additional context** Add any other context about the problem here.
+

.github/issue_template/feature_request.md

@@ -0,0 +1,18 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+---
+
+# feature\_request
+
+**Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. Ex. I'm always frustrated when \[...\]
+
+**Describe the solution you'd like** A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered** A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context** Add any other context or screenshots about the feature request here.
+

.github/pull_request_template.md

@@ -0,0 +1,36 @@
+# PULL\_REQUEST\_TEMPLATE
+
+Description of PR...
+
+## Changes
+
+* Item 1
+* Item 2
+
+## API Updates
+
+### New Features _\(required\)_
+
+This section should include details regarding new features added to the library. This should include both open and private APIs. If including both, create two sub headers underneath this one to label updates accordingly.
+
+### Deprecations _\(required\)_
+
+All deprecations should be listed here in order to ensure the reviewer understands which sections of the codebase will affect contributors and users of the library.
+
+### Enhancements _\(optional\)_
+
+The enhancements section should include code updates that were included with this pull request. This sections should detail refactoring that might have affected other parts of the library.
+
+## Checklist
+
+* [ ] Unit tests
+* [ ] Documentation
+
+## References
+
+\(optional\)
+
+Include **important** links regarding the implementation of this PR. This usually includes and RFC or an aggregation of issues and/or individual conversations that helped put this solution together. This helps ensure there is a good aggregation of resources regarding the implementation.
+
+Fixes \#85, Fixes \#22, Fixes username/repo\#123 Connects \#123
+

README.md

@@ -1,33 +1,27 @@
-[![Coverage Status](https://coveralls.io/repos/github/JonatanMartens/pyzeebe/badge.svg?branch=master)](https://coveralls.io/github/JonatanMartens/pyzeebe?branch=master)
-![Test pyzeebe](https://github.com/JonatanMartens/pyzeebe/workflows/Test%20pyzeebe/badge.svg)
-![Integration test pyzeebe](https://github.com/JonatanMartens/pyzeebe/workflows/Integration%20test%20pyzeebe/badge.svg)
-![GitHub issues](https://img.shields.io/github/issues-raw/JonatanMartens/pyzeebe)
-![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/JonatanMartens/pyzeebe)
-![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed-raw/JonatanMartens/pyzeebe)
-![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/JonatanMartens/pyzeebe)
-![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyzeebe)
-![PyPI](https://img.shields.io/pypi/v/pyzeebe)
+# README
 
+[![Coverage Status](https://coveralls.io/repos/github/JonatanMartens/pyzeebe/badge.svg?branch=master)](https://coveralls.io/github/JonatanMartens/pyzeebe?branch=master) ![Test pyzeebe](https://github.com/JonatanMartens/pyzeebe/workflows/Test%20pyzeebe/badge.svg) ![Integration test pyzeebe](https://github.com/JonatanMartens/pyzeebe/workflows/Integration%20test%20pyzeebe/badge.svg) ![GitHub issues](https://img.shields.io/github/issues-raw/JonatanMartens/pyzeebe) ![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/JonatanMartens/pyzeebe) ![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed-raw/JonatanMartens/pyzeebe) ![GitHub tag \(latest by date\)](https://img.shields.io/github/v/tag/JonatanMartens/pyzeebe) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyzeebe) ![PyPI](https://img.shields.io/pypi/v/pyzeebe)
 
+## Pyzeebe
 
-# Pyzeebe
 pyzeebe is a python grpc client for Zeebe.
 
 Zeebe version support:
 
 | Pyzeebe version | Tested Zeebe versions |
-|:---------------:|----------------|
-| 2.x.x           | 0.23, 0.24         |
-| 1.x.x           | 0.23, 0.24         |
+| :---: | :--- |
+| 2.x.x | 0.23, 0.24 |
+| 1.x.x | 0.23, 0.24 |
+
+### Getting Started
 
-## Getting Started
 To install:
 
 `pip install pyzeebe`
 
-## Usage
+### Usage
 
-### Worker
+#### Worker
 
 The `ZeebeWorker` class uses threading to get and run jobs.
 
@@ -55,12 +49,13 @@ worker.work() # Now every time that a task with type example is called example_t
 ```
 
 Stop a worker:
+
 ```python
 zeebe_worker.work() # Worker will begin working
-zeebe_worker.stop() # Stops worker after all running jobs have been completed 
+zeebe_worker.stop() # Stops worker after all running jobs have been completed
 ```
 
-### Client
+#### Client
 
 ```python
 from pyzeebe import ZeebeClient
@@ -83,22 +78,25 @@ zeebe_client.cancel_workflow_instance(workflow_instance_key=12345)
 
 # Publish message
 zeebe_client.publish_message(name="message_name", correlation_key="some_id")
-
 ```
 
-## Tests
+### Tests
+
 Use the package manager [pip](https://pip.pypa.io/en/stable/) to install pyzeebe
- 
+
 `pytest tests/unit`
 
-## Contributing
+### Contributing
+
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 
 Please make sure to update tests as appropriate.
 
+### Versioning
+
+We use [SemVer](https://github.com/JonatanMartens/pyzeebe/tree/4202906527cd989ac80ba738dbb81f20ebf58ff0/semver.org) for versioning. For the versions available, see the tags on this repository.
+
+### License
 
-## Versioning
-We use [SemVer](semver.org) for versioning. For the versions available, see the tags on this repository.
+We use the MIT license, see [LICENSE.md](license.md) for details
 
-## License
-We use the MIT license, see [LICENSE.md](LICENSE.md) for details