Update PULL_REQUEST_TEMPLATE.md

pull/1374/head
Ron 2025-08-01 23:12:04 +02:00 committed by GitHub
parent 8e6ff2acf9
commit 14d2c030c0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 53 additions and 5 deletions

View File

@ -1,24 +1,68 @@
## Description: ## Description:
**Related issue (if applicable):** #<!--apprise issue number goes here--> **Related issue (if applicable):** #<!--apprise issue number goes here-->
<!-- Have anything else to describe? Define it here --> <!-- Have anything else to describe? Define it here; this helps build the wiki item later
-- Delete this section if you are not creating a new plugin --
## *ServiceName* Notifications
* **Source**: https://official.website.example.ca
* **Icon Support**: Yes / No
* **Message Format**: Plain Text / HTML / Markdown
* **Message Limit**: nn Characters
Describe your service here..
### 🛠️ Setup Instructions
1. Visit [service.site](https://example.ca/) and sign in using your account credentials.
2. Once logged in, generate and copy your **token** ...
---
### ✅ Apprise Support
### Syntax
Valid syntax is as follows:
- `service://{variable}`
---
### 🔐 Parameter Breakdown
| Variable | Required | Description |
|-----------|----------|----------------|
| variable1 | Yes | Your variable1 |
| variable2 | No | Your variable2 |
---
### 📦 Examples
Sends a simple example
```bash
apprise -vv -t "Title" -b "Message content" \
service://token
```
## New Service Completion Status ## New Service Completion Status
<!-- This section is only applicable if you're adding a new service --> <!-- This section is only applicable if you're adding a new service -->
* [ ] apprise/plugins/<!--new plugin name -->.py * [ ] apprise/plugins/<!--new plugin name -->.py
* [ ] KEYWORDS * [ ] pypackage.toml update `keywords` section to identify our new service
- add new service into this file (alphabetically). - add new service into this file (alphabetically).
* [ ] README.md * [ ] README.md
- add entry for new service to table (as a quick reference) - add entry for new service to table (as a quick reference)
* [ ] packaging/redhat/python-apprise.spec * [ ] packaging/redhat/python-apprise.spec
- add new service into the `%global common_description` - add new service into the `%global common_description`
-- END OF NEW PLUGIN SECTION - REMOVE ABOVE SECION IF NOT A NEW PLUGIN -->
## Checklist ## Checklist
<!-- The following must be completed or your PR can't be merged --> <!-- The following must be completed or your PR can't be merged -->
* [ ] The code change is tested and works locally. * [ ] The code change is tested and works locally.
* [ ] There is no commented out code in this PR. * [ ] There is no commented out code in this PR.
* [ ] No lint errors (use `flake8`) * [ ] No lint errors (use `tox -e lint` and even `tox -e format` to autofix what it can)
* [ ] 100% test coverage * [ ] Test coverage added (use `tox -e minimal`)
## Testing ## Testing
<!-- If this your code is testable by other users of the program <!-- If this your code is testable by other users of the program
@ -41,4 +85,8 @@ pip install git+https://github.com/caronc/apprise.git@<this.branch-name>
apprise -t "Test Title" -b "Test Message" \ apprise -t "Test Title" -b "Test Message" \
<apprise url related to ticket> <apprise url related to ticket>
# If you have cloned the branch and have tox available to you
# the following can also allow you to test:
tox -e apprise -- -t "Test Title" -b "Test Message" \
<apprise url related to ticket>
``` ```