-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
127 changed files
with
3,261 additions
and
3,819 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
# Code of Conduct - aiogram-broadcaster | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to make participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, sex characteristics, gender identity and expression, | ||
level of experience, education, socio-economic status, nationality, personal | ||
appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment for our | ||
community include: | ||
|
||
* Demonstrating empathy and kindness toward other people | ||
* Being respectful of differing opinions, viewpoints, and experiences | ||
* Giving and gracefully accepting constructive feedback | ||
* Accepting responsibility and apologizing to those affected by our mistakes, | ||
and learning from the experience | ||
* Focusing on what is best not just for us as individuals, but for the | ||
overall community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
* The use of sexualized language or imagery, and sexual attention or | ||
advances | ||
* Trolling, insulting or derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or email | ||
address, without their explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying and enforcing our standards of | ||
acceptable behavior and will take appropriate and fair corrective action in | ||
response to any behavior that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject | ||
comments, commits, code, wiki edits, issues, and other contributions that are | ||
not aligned to this Code of Conduct, and will | ||
communicate reasons for moderation decisions when appropriate. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also applies when | ||
an individual is officially representing the community in public spaces. | ||
Examples of representing our community include using an official e-mail address, | ||
posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported to the community leaders responsible for enforcement at <[email protected]>. | ||
All complaints will be reviewed and investigated promptly and fairly. | ||
|
||
All community leaders are obligated to respect the privacy and security of the | ||
reporter of any incident. | ||
|
||
## Enforcement Guidelines | ||
|
||
Community leaders will follow these Community Impact Guidelines in determining | ||
the consequences for any action they deem in violation of this Code of Conduct: | ||
|
||
### 1. Correction | ||
|
||
**Community Impact**: Use of inappropriate language or other behavior deemed | ||
unprofessional or unwelcome in the community. | ||
|
||
**Consequence**: A private, written warning from community leaders, providing | ||
clarity around the nature of the violation and an explanation of why the | ||
behavior was inappropriate. A public apology may be requested. | ||
|
||
### 2. Warning | ||
|
||
**Community Impact**: A violation through a single incident or series | ||
of actions. | ||
|
||
**Consequence**: A warning with consequences for continued behavior. No | ||
interaction with the people involved, including unsolicited interaction with | ||
those enforcing the Code of Conduct, for a specified period of time. This | ||
includes avoiding interactions in community spaces as well as external channels | ||
like social media. Violating these terms may lead to a temporary or | ||
permanent ban. | ||
|
||
### 3. Temporary Ban | ||
|
||
**Community Impact**: A serious violation of community standards, including | ||
sustained inappropriate behavior. | ||
|
||
**Consequence**: A temporary ban from any sort of interaction or public | ||
communication with the community for a specified period of time. No public or | ||
private interaction with the people involved, including unsolicited interaction | ||
with those enforcing the Code of Conduct, is allowed during this period. | ||
Violating these terms may lead to a permanent ban. | ||
|
||
### 4. Permanent Ban | ||
|
||
**Community Impact**: Demonstrating a pattern of violation of community | ||
standards, including sustained inappropriate behavior, harassment of an | ||
individual, or aggression toward or disparagement of classes of individuals. | ||
|
||
**Consequence**: A permanent ban from any sort of public interaction within | ||
the community. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version | ||
[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and | ||
[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md), | ||
and was generated by [contributing-gen](https://github.com/bttger/contributing-gen). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
custom: https://donatello.to/lores |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
name: Bug report | ||
description: Report issues affecting the framework or the documentation. | ||
labels: | ||
- bug | ||
|
||
body: | ||
- type: checkboxes | ||
attributes: | ||
label: Checklist | ||
options: | ||
- label: I am sure the error is coming from aiogram_broadcaster code | ||
required: true | ||
- label: >- | ||
I have searched in the issue tracker for similar bug reports, | ||
including closed ones | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: > | ||
## Context | ||
Please provide as much information as possible. This will help us to | ||
reproduce the issue and fix it. | ||
- type: input | ||
attributes: | ||
label: Operating system | ||
placeholder: e.g. Ubuntu 20.04.2 LTS | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
attributes: | ||
label: Python version | ||
description: (`python --version` inside your virtualenv) | ||
placeholder: e.g. 3.10.1 | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
attributes: | ||
label: aiogram_broadcaster version | ||
description: (`pip show aiogram_broadcaster` inside your virtualenv) | ||
placeholder: e.g. 0.4.7 or 0.5.0 | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Expected behavior | ||
description: Please describe the behavior you are expecting. | ||
placeholder: 'E.g. the bot should send a message with the text "Hello, world!".' | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Current behavior | ||
description: Please describe the behavior you are currently experiencing. | ||
placeholder: E.g. the bot doesn't send any message. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Steps to reproduce | ||
description: Please describe the steps you took to reproduce the behavior. | ||
placeholder: | | ||
1. step 1 | ||
2. step 2 | ||
3. ... | ||
4. you get it... | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Code example | ||
description: >- | ||
Provide a [minimal, | ||
reproducible](https://stackoverflow.com/help/minimal-reproducible-example) | ||
and properly formatted example (if applicable). | ||
placeholder: | | ||
from aiogram_broadcaster import Bot, Dispatcher | ||
... | ||
render: python3 | ||
|
||
- type: textarea | ||
attributes: | ||
label: Logs | ||
description: Provide the complete traceback (if applicable) or other kind of logs. | ||
placeholder: | | ||
Traceback (most recent call last): | ||
File "main.py", line 1, in <module> | ||
... | ||
SomeException: ... | ||
render: sh | ||
|
||
- type: textarea | ||
attributes: | ||
label: Additional information | ||
description: >- | ||
Please provide any additional information that may help us to reproduce | ||
the issue. | ||
placeholder: | | ||
E.g. this behavior is reproducible only in group chats. | ||
You can also attach additional screenshots, logs, or other files. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
blank_issues_enabled: true | ||
|
||
contact_links: | ||
- name: Discuss anything related to the library | ||
url: https://github.com/loRes228/aiogram_broadcaster/discussions | ||
about: Ask a question about aiogram-broadcaster or share your code snippets and ideas. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
name: Feature request | ||
description: Report features you would like to see or improve in the framework. | ||
labels: | ||
- enhancement | ||
|
||
body: | ||
- type: textarea | ||
attributes: | ||
label: aiogram_broadcaster version | ||
description: (`pip show aiogram_broadcaster` inside your virtualenv) | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Problem | ||
description: Is your feature request related to a specific problem? If not, please describe the general idea of your request. | ||
placeholder: e.g. I want to send a photo to a user by url. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Possible solution | ||
description: Describe the solution you would like to see in the framework. | ||
placeholder: e.g. Add a method to send a photo to a user by url. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Alternatives | ||
description: What other solutions do you have in mind? | ||
placeholder: e.g. I'm sending a text message with photo url. | ||
|
||
- type: textarea | ||
attributes: | ||
label: Code example | ||
description: A small code example that demonstrates the behavior you would like to see. | ||
placeholder: | | ||
await broadcaster.create_mailer(content, chat_ids) | ||
... | ||
render: python3 | ||
|
||
- type: textarea | ||
attributes: | ||
label: Additional information | ||
description: Any additional information you would like to provide. | ||
placeholder: | | ||
E.g. this method should also cache images to speed up further sending. | ||
You can also attach additional pictures or other files. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Description | ||
|
||
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this | ||
change. | ||
|
||
Fixes # (issue) | ||
|
||
## Type of change | ||
|
||
Please delete options that are not relevant. | ||
|
||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
- [ ] This change requires a documentation update | ||
|
||
# How Has This Been Tested? | ||
|
||
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration | ||
|
||
- [ ] Test A | ||
- [ ] Test B | ||
|
||
**Test Configuration**: | ||
|
||
* Firmware version: | ||
* Hardware: | ||
* Toolchain: | ||
* SDK: | ||
|
||
# Checklist: | ||
|
||
- [ ] My code follows the style guidelines of this project | ||
- [ ] I have performed a self-review of my code | ||
- [ ] I have commented my code, particularly in hard-to-understand areas | ||
- [ ] I have made corresponding changes to the documentation | ||
- [ ] My changes generate no new warnings | ||
- [ ] I have added tests that prove my fix is effective or that my feature works | ||
- [ ] New and existing unit tests pass locally with my changes | ||
- [ ] Any dependent changes have been merged and published in downstream modules |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# **Reporting Security Issues** | ||
|
||
The project's team and community take security issues. | ||
|
||
We appreciate your efforts to disclose your findings responsibly and will make every effort to acknowledge your contributions. | ||
|
||
If your report could leak data or might expose how to gain access to a restricted area or break the system, please | ||
send a message to my telegram - https://t.me/lores1337. | ||
|
||
We'll endeavour to respond quickly and keep you updated throughout the process. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,8 @@ | ||
.venv/ | ||
.tests/ | ||
.dev/ | ||
.idea/ | ||
.vscode/ | ||
.cache/ | ||
.codegen/ | ||
dist/ | ||
__pycache__/ | ||
.python-version |
Oops, something went wrong.