Skip to content

Commit

Permalink
Merge branch 'release/v0.10.3'
Browse files Browse the repository at this point in the history
* release/v0.10.3:
  Bump version from 0.10.2 to 0.10.3
  Add PR templates, modify issue templates (#151)
  Add missing newsfragment
  Add contribution guidlines (#149)
  Create CONTRIBUTING.md
  Docs: Fix wrong path for typehints.py
  Rename module typing to types (#147)
  Move docs back to rtd (#145)
  Sanitize event_id of get-event (#144)
  • Loading branch information
MichaelSasser committed Jun 26, 2021
2 parents 3fa15d8 + 69a205e commit 9e8d34a
Show file tree
Hide file tree
Showing 31 changed files with 1,212 additions and 257 deletions.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: "\U0001F41B Bug report"
about: Create a report to help us improve

---

<!--
Thank you for reporting a possible bug in MatrixCtl.
Please fill in as much of the template below as you can.
MatrixCtl Version: output of `matrixctl --version`
Platform: output of `uname -a` (UNIX), or version and 32 or 64-bit (Windows)
If possible, please provide the debug output by running the same command again
with a `-d` argument after `matrixctl` e.g. `matrixctl -d command`.
-->

- **MatrixCtl Version**:
- **Python Version**:
- **Platform**:

#### Describe the bug
<!-- A clear and concise description of what the bug is. -->


#### Expected behavior
<!-- A clear and concise description of what you expected to happen. -->


#### Debug output
<!-- Please provide the debug output here -->


#### Additional context
<!-- Add any other context about the problem here. -->
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: "\U0001F680 Feature request"
about: Suggest an idea for this project

---

<!--
Thank you for suggesting an idea to make MatrixCtl better.
Please fill in as much of the template below as you're able.
-->

#### 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. -->
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/3-help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: "⁉️ Need help with Node.js?"
about: Please use https://github.com/MichaelSasser/matrixctl/discussions

---

If you have a question about MatrixCtl (or Contribution) that is not a bug
report or feature request, please post it in the
[discussions](https://github.com/MichaelSasser/matrixctl/discussions)

Questions posted in the issues will be closed.
29 changes: 0 additions & 29 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

38 changes: 38 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/Feature_Bugfix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<!--
**IMPORTANT: Please do not create a Pull Request without creating an issue first.**
Thank you for your pull request. Please provide a description above and review
the requirements below.
Bug fixes and new features should include documentation and tests.
-->

fixes #

#### Affected Handlers
<!-- Please provide affected handlers. -->

#### Description of Change
<!-- Please provide a description of the change here. -->
-
-
-

#### Checklist
<!-- Only the fields marked with (*) are Mandatory for bugfixes. -->

- [ ] Have you documented your changes?
- [ ] Have you added or changed tests for your code?
- [ ] (*) Have you created an issue first?
- [ ] (*) Have you checked to ensure there aren't other open Pull Requests
for the same update/change?
- [ ] (*) Have you created a newsfragment in `./news/`?
- [ ] (*) Have you lint your code locally prior to submission?
- [ ] (*) Did you ran `tox` and everything passed?
- [ ] (*) I haven't added any dependencie without approval.

<!-- [Code of Conduct & Contribution Guidlines](https://matrixctl.rtfd.io/en/latest/contributer_documentation/index.html). -->
I have read and accept the:

- [ ] (*) Code of Conduct.
- [ ] (*) Contribution Guidelines.
12 changes: 6 additions & 6 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,9 @@ repos:
hooks:
- id: vulture

# PEP 585 Upgrade (Type Hints)
- repo: https://github.com/sondrelg/pep585-upgrade
# Use the sha / tag you want to point at
rev: 'ab1595ee0aa8823dcda1f0bd95b2c194fcd5362b'
hooks:
- id: upgrade-type-hints
# # PEP 585 Upgrade (Type Hints)
# - repo: https://github.com/sondrelg/pep585-upgrade
# # Use the sha / tag you want to point at
# rev: 'ab1595ee0aa8823dcda1f0bd95b2c194fcd5362b'
# hooks:
# - id: upgrade-type-hints
32 changes: 32 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# matrixctl
# Copyright (c) 2021 Michael Sasser <[email protected]>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.

---

version: 2

sphinx:
configuration: docs/source/conf.py

formats: all

python:
version: 3.8
install:
- method: pip
path: .
extra_requirements:
- docs
Loading

0 comments on commit 9e8d34a

Please sign in to comment.