Skip to content

Commit

Permalink
Contribution details updated.
Browse files Browse the repository at this point in the history
- Updated documentation regarding contribution.
- Added PR template
  • Loading branch information
hbldh committed Oct 22, 2020
1 parent e6c7f86 commit 1156b2a
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 9 deletions.
10 changes: 8 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
* bleak version:
* Python version:
* Operating System:
* BlueZ version (`bluetoothctl -v`) in case of Linux:
* BlueZ version (`bluetoothctl -v`) in case of Linux:

### Description

Expand All @@ -10,7 +10,13 @@ Tell us what happened, what went wrong, and what you expected to happen.

### What I Did

It is preferable if an issue contains a [Miminal Workable Example](https://stackoverflow.com/help/minimal-reproducible-example).
This will otherwise be one of the first questions you will get as a response.

It is also preferable if that example is not dependent on a specific peripheral device, but can be run and
reproduced with other BLE peripherals as well.

```
Paste the command(s) you ran and the output.
If there was a crash, please include the traceback here.
If there was a crash, please include the traceback here as well.
```
16 changes: 16 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Pull Request Guidelines for Bleak
---------------------------------

Before you submit a pull request, check that it meets these guidelines:

1. If the pull request adds functionality, the docs should be updated.
2. Modify the `CHANGELOG.rst`, describing your changes as is specified by the
guidelines in that document.
3. The pull request should work for Python 3.6+ on the following platforms:
- Windows 10, version 16299 (Fall Creators Update) and greater
- Linux distributions with BlueZ >= 5.43
- OS X / macOS >= 10.11
4. Squash all your commits on your PR branch, if the commits are not solving
different problems and you are committing them in the same PR. In that case,
consider making several PRs instead.
5. Feel free to add your name as a contributor to the `AUTHORS.rst` file!
7 changes: 6 additions & 1 deletion AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,12 @@ Development Lead

* Henrik Blidh <[email protected]>

Development Team / Collaborators
--------------------------------

* David Lechner <[email protected]>

Contributors
------------

* David Lechner <[email protected]>

7 changes: 7 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ Added
~~~~~

* Added new attribute ``_device_info`` on ``BleakClientBlueZDBus``. Merges #347
* Added Pull Request Template.

Changed
~~~~~~~

* Updated instructions on how to contribute, file issues and make PRs.
* Updated ``AUTHORS.rst`` file with development team.

Fixed
~~~~~
Expand Down
13 changes: 7 additions & 6 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,13 +98,14 @@ Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
1. If the pull request adds functionality, the docs should be updated.
2. Modify the ``CHANGELOG.rst``, describing your changes as is specified by the
guidelines in that document.
3. The pull request should work for Python 3.6+ on the following platforms:
- Windows 10, version 16299 (Fall Creators Update) and greater
- Linux distributions with BlueZ >= 5.43
- OS X / macOS >= 10.11
4. Feel free to add your name to the ``AUTHORS.rst`` in the root of the project!

4. Squash all your commits on your PR branch, if the commits are not solving
different problems and you are committing them in the same PR. In that case,
consider making several PRs instead.
5. Feel free to add your name as a contributor to the ``AUTHORS.rst`` file!

0 comments on commit 1156b2a

Please sign in to comment.