Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
eac4eb0
+ Added CODEOWNERS
caffeine-addictt Dec 13, 2023
903382f
+ Added test worker workflow
caffeine-addictt Dec 13, 2023
e0bbf76
+ Added base runner script
caffeine-addictt Dec 13, 2023
a7d1947
+ Added gitignore
caffeine-addictt Dec 13, 2023
96616a4
+ Added poetry lock and pyproject
caffeine-addictt Dec 13, 2023
aedd0b3
+ Added __init__.py
caffeine-addictt Dec 13, 2023
ca695a4
+ Added base app
caffeine-addictt Dec 13, 2023
c87faad
+ Added utils
caffeine-addictt Dec 13, 2023
804e544
+ Added help commands
caffeine-addictt Dec 13, 2023
ffc119c
+ Added Configuration setup
caffeine-addictt Dec 13, 2023
9a42aa6
+ Added Error manager
caffeine-addictt Dec 13, 2023
18cec89
+ Added type hinting
caffeine-addictt Dec 14, 2023
d1b7002
+ Added runner script
caffeine-addictt Dec 14, 2023
ddbe9d3
Migrated app.py -> __init__.py
caffeine-addictt Dec 14, 2023
54ba9bf
+ Added contributing.md
caffeine-addictt Dec 14, 2023
ed03e0b
+ Added CODESTYLE
caffeine-addictt Dec 14, 2023
d50dc1d
+ Added PR tempalte
caffeine-addictt Dec 14, 2023
c6025ea
+ Added SECURITY.md
caffeine-addictt Dec 14, 2023
ec9d69b
+ Added settings config
caffeine-addictt Dec 14, 2023
1580ed3
+ Added issue templates
caffeine-addictt Dec 14, 2023
528b1a8
+ Added test placeholder
caffeine-addictt Dec 14, 2023
e3388da
- Removed unused import
caffeine-addictt Dec 14, 2023
ef3b9ed
+ Added space
caffeine-addictt Dec 14, 2023
0a11015
+ Custom Comamnd check
caffeine-addictt Dec 14, 2023
df2bff7
+ Developer Commands
caffeine-addictt Dec 14, 2023
4478795
+ Invite manager
caffeine-addictt Dec 14, 2023
99d9120
+ Type hinting
caffeine-addictt Dec 14, 2023
51345e4
+ Config variables
caffeine-addictt Dec 14, 2023
128c8af
+ Added .vscode to gitignore
caffeine-addictt Dec 14, 2023
0f3fa6b
+ Added checking for bot token
caffeine-addictt Dec 14, 2023
0bce957
+ Bug fix
caffeine-addictt Dec 14, 2023
8a611ff
Type hint Bot token optional
caffeine-addictt Dec 14, 2023
fd5955f
Update cog name
caffeine-addictt Dec 14, 2023
905f039
Fixed parameter namespace
caffeine-addictt Dec 14, 2023
6de5aee
+ Added view pagination
caffeine-addictt Dec 14, 2023
0ded28e
Refactor help command
caffeine-addictt Dec 14, 2023
36303ea
Refactor invite manager
caffeine-addictt Dec 14, 2023
3ba50fc
+ Added misc commands
caffeine-addictt Dec 14, 2023
1a06b8b
+ Added emoji dependency
caffeine-addictt Dec 14, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @caffeine-addictt
111 changes: 111 additions & 0 deletions .github/CODESTYLE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
# Code Style
The following is a general guide on how to style your work so that the project
remains consistent throughout all files. Please read this document in it's entirety
and refer to it throughout the development of your contribution.

1. [General Guidelines](#general-guidelines)
2. [Commit Message Guidelines](#commit-message-guidelines)
3. [Markdown Guidelines](#markdown-guidelines)



## General Guidelines
Listed is a example class used demonstrate general rules you should follow throughout the development of your contribution.

- Docstrings are to follow reST (reStructuredText Docstring Format) as specified in [PEP 287](https://peps.python.org/pep-0287/)
- Private attributes are to be prefixed with an underscore
- Use of [typing](https://docs.python.org/3/library/typing.html) type hints
- All files are to use 2 space indenting

```python
class ExampleClass:
"""
ExampleClass
------------
Example class for CODESTYLE.md
"""
# ^^^ reST Docstring Format

_private_attribute : int # private attributes begin with a lowercase
public_attribute : int # type hint for integer is defined here

def __init__(
self,
public_attribute: int # type hint for parameters
) -> None: # the expected return value of method
"""
Initializes a ExampleClass

Parameters
----------
:param public_attribute: example attribute
"""
self.public_attribute = public_attribute
self.private_attribute = square(public_attribute)

def square(self, value: int) -> int:
"""
Example method that square roots a value

Parameters
----------
:param value: value that you want squared
"""
return value**2
```



## Commit Message Guidelines
When committing, commit messages are prefixed with a `+` or `-`. Depending on the type of change made
influences which prefix is used.

- `+` when something is added.
- `-` when something is removed.
- none: when neither is applicable, like merge commits.

Commit messages are also to begin with an uppercase character. Below list some example commit messages.

```
git commit -m "+ Added README.md"
git commit -m "- Removed README.md"
git commit -m "Moved README.md"
```



## Markdown Guidelines
Currently, documentation for this project resides in markdown files.
- Headings are to be separated with 3 lines
- Use of HTML comments is appreciated
- Use of HTML is permitted
- [reference style links](https://www.markdownguide.org/basic-syntax/#reference-style-links) are not required by are appreciated
- Exceedingly long lines are to be broken
- The indents are to be two spaces

```markdown
<!--example markdown document-->
# Section
Lorem ipsum dolor sit amet, consectetur adipiscing elit,
sed do eiusmod tempor incididunt ut labore et dolore
magna aliqua. Ut enim ad minim veniam, quis nostrud
exercitation ullamco laboris nisi ut aliquip ex ea
commodo consequat. Duis aute irure dolor in
reprehenderit in voluptate velit esse cillum dolore eu
fugiat nulla pariatur. Excepteur sint occaecat cupidatat
non proident, sunt in culpa qui officia deserunt mollit
anim id est laborum. found [Lorem Ipsum Generator]



# Section 2
<ul>
<li> Apple
<li> Orange
<li> Pineapple
</ul>



[Lorem Ipsum Generator]: https://loremipsum.io/generator/
```
27 changes: 27 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# **Contributing**

When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change.

Please note we have a [code of conduct](CODE_OF_CONDUCT.md); please follow it in all your interactions with the project.



## Pull Request Process

1. Ensure any install or build dependencies are removed before the end of the layer when doing a
build.
2. Update the README.md with details of changes to the interface; this includes new environment variables, exposed ports, valid file locations and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new version that this
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
4. You may merge the Pull Request once you have the sign-off of two other developers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.



## Issue Report Process

1. Go to the project's issues.
2. Select the template that better fits your issue.
3. Read the instructions carefully and write within the template guidelines.
4. Submit it and wait for support.
82 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
name: "Bug Report"
about: "Report an issue to help the project improve."
title: "[Bug] "
labels: "Type: Bug"
assignees: caffeine-addictt

---

# Bug report
Your issue may already be reported!
Please check out our [active issues](https://github.com/python-thread/thread-bot/issues) before creating one.



## Expected Behavior
<!--
If you're describing a bug, tell us what should happen
If you're suggesting a change/improvement, tell us how it should work

Please include screenshots and/or code snippets if applicable
-->



## Current Behavior
<!--
If describing a bug, tell us what happens instead of the expected behavior
If suggesting a change/improvement, explain the difference from current behavior

Please include screenshots and/or code snippets if applicable
-->



## Is this a regression?
<!--
Did this behaviour use to work in previous versions?
If yes, what is the latest version where this behaviour is not present?
-->



## Possible Solution
<!--
Not obligatory, but suggest a fix/reason for the bug
or ideas how to implement the addition or change
-->



## Steps to Reproduce (for bugs)
<!--
Provide a link to a live example, or an unambiguous set of steps to reproduce this bug.
-->
1.
2.
3.
4.



## Context
<!--
How has this issue affected you?
What are you trying to accomplish?

Providing context helps us come up with a solution that is most useful in the real world.

Please include screenshots and/or code snippets if applicable
-->



## Your Environment
<!--
Include as many relevant details about the environment you experienced the bug in
-->
* Version used:
* Python version:
* Link to your project:
* Operating System and version (desktop or mobile):
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: "Feature Request"
about: "Suggest an idea or possible new feature for this project."
title: ""
labels: "Type: Feature"
assignees: caffeine-addictt

---

# Feature Request
Your issue may already be reported!
Please check out our [active issues](https://github.com/python-thread/thread-bot/issues) before creating one.



## Is Your Feature Request Related to an Issue?
<!--
If yes, provide a clear and concise description of what the problem is
E.g.:
Issue #
I'm always frustrated when...
-->



## Describe the Solution You'd Like
<!--
A clear and concise description of what you'd like
-->



## Describe Alternatives You've Considered
<!--
A clear and concise description of other alternatives you have considered
-->



## Additional Context
<!--
Any other extra context or information
-->
97 changes: 97 additions & 0 deletions .github/ISSUE_TEMPLATE/3-seccurity-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
name: "Security Report"
about: "Report an issue to help the project improve."
title: ""
labels: "Type: Security"
assignees: caffeine-addictt

---

<!--

Oh, hi there! 😄

To expedite issue processing, please search open and closed issues before submitting a new one.
Please read our Rules of Conduct at this repository's `.github/CODE_OF_CONDUCT.md`

FIRST OF ALL, read this project's SECURITY.md file. Located in `.github/SECURITY.md`.

READ CAREFULLY IF YOUR ISSUE REPORT CONTAINS SENSIBLE OR PRIVATE DATA:
(data that might be leaked or subtracted from our servers due to this
security issue).

If this security report (or the guide on how to "identify the security bug") includes
certain personal information or involves personal identifiable data, or you believe
that the data that you might leak by exposing the way on how to attack the project
could be considered as a data leak or could violate the privacy of any kind of
data or sensible data, please do not post it here and directly email the developer:
(jgracia9988@gmail.com). You should post the issue with the least amount of
sensible or private data as possible to help us manage the security issue, and
with the extra data sent from your email to the developer (if any), we will deeply
analyze and try to fix it as fast as possible.

If you are in doubt about the data that you might post here (screenshots or media
also, count as data), please directly email us.

The data that must NOT be posted here:

* Legal and/or full names
* Names or usernames combined with other identifiers like phone numbers or email addresses
* Health or financial information (including insurance information, social security numbers, etc.)
* Information about political or religious affiliations
* Information about race, ethnicity, sexual orientation, gender, or other identifying information that could be used for discriminatory purposes

-->

# Security Report
Your issue may already be reported!
Please check out our [active issues](https://github.com/python-thread/thread-bot/issues) before creating one.



## Describe the Security Issue
<!--
A clear and concise description of the security issue
-->



## Steps to Reproduce
<!--
e.g.:
1. Navigate to x
2. Go to...
3. See error
-->



## Expected Behavior
<!--
A clear and concise description of the expected behavior
-->



## Media Prove
<!--
If applicable, provide screenshots, videos and/or code snippets
-->



## Additional Context
<!--
Any other extra context or information
-->



### Your Environment
<!--
Include as many relevant details about the environment you experienced the bug in
-->
* Version used:
* Python version:
* Link to your project:
* Operating System and version (desktop or mobile):
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/4-question-support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: "Question or Support Request"
about: "Questions and requests for support."
title: ""
labels: "Type: Question"
assignees: caffeine-addictt

---

# Question or Support Request




## Describe your question or ask for support
<!--
A clear and concise description of what your doubt is
-->

*
Loading