-
Notifications
You must be signed in to change notification settings - Fork 3
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
32 changed files
with
901 additions
and
3 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# EditorConfig configuration file, see: https://editorconfig.org/ | ||
|
||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
indent_style = space | ||
indent_size = 4 | ||
tab_width = 4 | ||
end_of_line = lf | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true | ||
|
||
[*.yml] | ||
indent_size = 2 | ||
tab_width = 2 | ||
|
||
[*.rst] | ||
indent_size = 3 | ||
tab_width = 3 | ||
|
||
[Makefile] | ||
indent_style = tab |
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,5 @@ | ||
# Handle default line endings | ||
* text=auto eol=lf | ||
*.bat eol=crlf | ||
*.png binary | ||
*.ico binary |
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,26 @@ | ||
--- | ||
name: Bug report | ||
about: File a bug report to help improve Clamor | ||
|
||
--- | ||
|
||
## 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. | ||
|
||
## Additional context | ||
|
||
Add any additional context about the problem here. |
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,23 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for Clamor | ||
|
||
--- | ||
|
||
## Is your feature request related to a problem? Please describe. | ||
|
||
A clear and concise description of what the problem is. | ||
|
||
_Example:_ 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. |
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,31 @@ | ||
--- | ||
name: Support inquiry | ||
about: Support with Clamor | ||
|
||
--- | ||
|
||
*Please consider joining our [Discord guild](https://discord.gg/HbKGrVT) for faster and more direct help.* | ||
|
||
## Is your issue related to a problem with code? Please describe. | ||
|
||
A clear and concise description of what the problem is. | ||
|
||
_Example:_ My problem isn't related to code. I wanted to ask about x. | ||
|
||
## Describe the expected behavior | ||
|
||
A clear and concise description of what you want to happen. | ||
|
||
## Describe the actual behavior | ||
|
||
A clear and concise description of what happens instead. | ||
|
||
## The code you tried (for code-related issues) | ||
|
||
```python | ||
# Code here | ||
``` | ||
|
||
## Errors (if any) | ||
|
||
_The errors you've encountered (if any)._ |
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,44 @@ | ||
# Pull Request Template | ||
|
||
Please try to complete the below as best as possible. Some of the fields | ||
may not be necessary so feel free to add or edit as you see fit. | ||
|
||
## Checklist | ||
|
||
_Confirm you have completed the following actions prior to submitting this PR._ | ||
|
||
- [ ] There is an existing issue report for this PR. | ||
- [ ] I have forked this project. | ||
- [ ] I have created a feature branch. | ||
- [ ] My changes have been committed. | ||
- [ ] I have pushed my changes to the branch. | ||
|
||
## Title | ||
|
||
_Give your PR a short title summarising the patch, bug fix or feature._ | ||
|
||
## Description | ||
|
||
_Ensure the PR description clearly describes the problem and solution and provide as much relevant information as possible._ | ||
|
||
## Issue Resolution | ||
|
||
_Tell us which issue this PR fixes._ | ||
|
||
This Pull Request fixes # | ||
|
||
## Proposed Changes | ||
|
||
_List your proposed changes below._ | ||
|
||
- This PR fixes a bug relating to... | ||
- Adding a patch that enhances the project. | ||
- Various bug fixes. | ||
|
||
## New or Changed Features | ||
|
||
_Does this PR provide new or changed features or enhancements? If so, what is included in this PR?_ | ||
|
||
* Enhancement to the templates. | ||
* Adds a new feature that does x, y and z. | ||
* Solves a long-standing bug that affects a, b and c. |
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 |
---|---|---|
|
@@ -102,3 +102,7 @@ venv.bak/ | |
|
||
# mypy | ||
.mypy_cache/ | ||
|
||
# Editors | ||
.idea/ | ||
.vscode/ |
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,4 @@ | ||
# https://pyup.io/ configuration file | ||
|
||
update: all | ||
label_prs: dependency update |
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,13 @@ | ||
formats: | ||
- htmlzip | ||
- epub | ||
|
||
requirements_file: .readthedocs/requirements.txt | ||
|
||
build: | ||
image: latest | ||
|
||
python: | ||
version: 3.6 | ||
setup_py_install: true | ||
pip_install: true |
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,3 @@ | ||
sphinx>=1.7.0 | ||
sphinx-autodoc-typehints>=1.6.0 | ||
sphinxcontrib-trio>=1.1.0 |
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,41 @@ | ||
language: python | ||
sudo: false | ||
cache: pip | ||
|
||
python: | ||
- "3.5" | ||
- "3.6" | ||
|
||
matrix: | ||
include: | ||
# Python 3.7 workaround | ||
- python: 3.7.3 | ||
dist: xenial | ||
sudo: true | ||
|
||
install: | ||
- pip install pylama | ||
- pip install -e . | ||
- pip install -U -r .readthedocs/requirements.txt | ||
|
||
script: | ||
# Linting | ||
- pylama . | ||
|
||
# Unit tests | ||
- python setup.py test | ||
|
||
# Build docs | ||
- make -C docs html | ||
|
||
before_deploy: | ||
# Remove junk generated by setup.py test | ||
- rm -rf *.egg-info | ||
|
||
deploy: | ||
provider: pypi | ||
user: $PYPI_DEPLOY_USER | ||
password: $PYPI_DEPLOY_PASSWORD | ||
skip_existing: true | ||
on: | ||
tags: true |
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,46 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. | ||
|
||
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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at valentin.be@protonmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] | ||
|
||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
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,81 @@ | ||
# Contributing to Clamor | ||
|
||
Clamor is a Discord API framework that couldn't exist without amazing people like you. | ||
So you decided to contribute? Great! But first, read these contribution guidelines to get started. | ||
|
||
## Code of Conduct | ||
|
||
Please note that this project has a [Code of Conduct][CoC] to which all contributors must adhere. | ||
|
||
## Reporting bugs | ||
|
||
Found a bug? Report it! Bug reports help us improving this software and making it more usable for everyone. | ||
|
||
**Please follow these simple standards for bug reports:** | ||
|
||
- Fill out the bug report template | ||
|
||
- Include the code you tried, all necessary details and the error you received | ||
|
||
## Contributing code or docs | ||
|
||
Before you start, please browse the [open issues][issues]. Contributions corresponding to issues labeled with | ||
`help wanted` are especially appreciated. | ||
|
||
However, other contributions are welcome too. We love to hear your ideas and suggestions on how to improve this | ||
project or review your submissions of code or docs. If you're planning to do major changes to the code, please | ||
open an issue in advance to discuss the changes or join our [Discord guild][Discord]. | ||
|
||
If you're new to Pull Requests on GitHub, here's an [introduction][PR introduction]. | ||
|
||
Pull Requests should, as much as possible, be self-contained and only address one issue. Therefore ten Pull Requests | ||
for ten small and unrelated changes are more appreciated than one big Pull Request with everything mixed together. | ||
This way, it is easier for us to maintain and review the changes and if there are problems with one of them, it | ||
won't hold up the others. | ||
|
||
By making a contribution to this repository, you certify that: | ||
|
||
- The contribution was created in whole or in part by you and you have the right to submit it under the conditions | ||
of the [MIT License][MIT] this project uses. | ||
|
||
- All the code is covered by carefully crafted tests and works flawlessly. If this is not the case, feel free to | ||
ask for help in the corresponding issue and state in detail with what you need help, what you've tried so far and | ||
what's the thing that makes you struggle. | ||
|
||
- You didn't increase any version number yourself unless you were told to do so. That's what we usually do for new | ||
releases when we think it is appropriate to do so. | ||
|
||
- Your code is consistent, follows the style guidelines and is well-documented. | ||
|
||
After your PR has passed all checks, Continuous Integration and has been approved by the maintainers, | ||
it'll be merged. | ||
|
||
## Contribution ideas | ||
|
||
There are many ways of contributing. If there is no [open issue][issues] that arouses your interest, here | ||
are some suggestions on ways of contributing. All contributions are valued. | ||
|
||
- Help people in the issues or on our [Discord guild][Discord] | ||
|
||
- Use Clamor in a project and give us feedback about what worked and what didn't | ||
|
||
- Write a blog post about your experiences with Clamor, good or bad | ||
|
||
- Comment on issues. | ||
|
||
- Review Pull Requests | ||
|
||
- Add tests | ||
|
||
- Fix bugs | ||
|
||
- Add features | ||
|
||
- Improve code or documentation | ||
|
||
[CoC]: ./CONTRIBUTING.md | ||
[issues]: https://github.com/clamor-py/Clamor/issues | ||
[Discord]: https://discord.gg/HbKGrVT | ||
[PR introduction]: https://help.github.com/articles/using-pull-requests | ||
[MIT]: https://choosealicense.com/licenses/mit | ||
[editorconfig]: ./.editorconfig |
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,6 @@ | ||
recursive-include clamor *.py | ||
recursive-include docs * | ||
recursive-include tests *.py | ||
include CODE_OF_CONDUCT.md CONTRIBUTING.md | ||
include README.rst | ||
include requirements.txt |
Oops, something went wrong.