Skip to content

Commit 3c600d0

Browse files
caffeine-addicttcaffeine-addictt
authored
Merge pull request #1 from python-thread/dev
Initial setup
2 parents c2f4621 + 1a06b8b commit 3c600d0

26 files changed

+2073
-0
lines changed

‎.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @caffeine-addictt

‎.github/CODESTYLE.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# Code Style
2+
The following is a general guide on how to style your work so that the project
3+
remains consistent throughout all files. Please read this document in it's entirety
4+
and refer to it throughout the development of your contribution.
5+
6+
1. [General Guidelines](#general-guidelines)
7+
2. [Commit Message Guidelines](#commit-message-guidelines)
8+
3. [Markdown Guidelines](#markdown-guidelines)
9+
10+
11+
12+
## General Guidelines
13+
Listed is a example class used demonstrate general rules you should follow throughout the development of your contribution.
14+
15+
- Docstrings are to follow reST (reStructuredText Docstring Format) as specified in [PEP 287](https://peps.python.org/pep-0287/)
16+
- Private attributes are to be prefixed with an underscore
17+
- Use of [typing](https://docs.python.org/3/library/typing.html) type hints
18+
- All files are to use 2 space indenting
19+
20+
```python
21+
class ExampleClass:
22+
"""
23+
ExampleClass
24+
------------
25+
Example class for CODESTYLE.md
26+
"""
27+
# ^^^ reST Docstring Format
28+
29+
_private_attribute : int # private attributes begin with a lowercase
30+
public_attribute : int # type hint for integer is defined here
31+
32+
def __init__(
33+
self,
34+
public_attribute: int # type hint for parameters
35+
) -> None: # the expected return value of method
36+
"""
37+
Initializes a ExampleClass
38+
39+
Parameters
40+
----------
41+
:param public_attribute: example attribute
42+
"""
43+
self.public_attribute = public_attribute
44+
self.private_attribute = square(public_attribute)
45+
46+
def square(self, value: int) -> int:
47+
"""
48+
Example method that square roots a value
49+
50+
Parameters
51+
----------
52+
:param value: value that you want squared
53+
"""
54+
return value**2
55+
```
56+
57+
58+
59+
## Commit Message Guidelines
60+
When committing, commit messages are prefixed with a `+` or `-`. Depending on the type of change made
61+
influences which prefix is used.
62+
63+
- `+` when something is added.
64+
- `-` when something is removed.
65+
- none: when neither is applicable, like merge commits.
66+
67+
Commit messages are also to begin with an uppercase character. Below list some example commit messages.
68+
69+
```
70+
git commit -m "+ Added README.md"
71+
git commit -m "- Removed README.md"
72+
git commit -m "Moved README.md"
73+
```
74+
75+
76+
77+
## Markdown Guidelines
78+
Currently, documentation for this project resides in markdown files.
79+
- Headings are to be separated with 3 lines
80+
- Use of HTML comments is appreciated
81+
- Use of HTML is permitted
82+
- [reference style links](https://www.markdownguide.org/basic-syntax/#reference-style-links) are not required by are appreciated
83+
- Exceedingly long lines are to be broken
84+
- The indents are to be two spaces
85+
86+
```markdown
87+
<!--example markdown document-->
88+
# Section
89+
Lorem ipsum dolor sit amet, consectetur adipiscing elit,
90+
sed do eiusmod tempor incididunt ut labore et dolore
91+
magna aliqua. Ut enim ad minim veniam, quis nostrud
92+
exercitation ullamco laboris nisi ut aliquip ex ea
93+
commodo consequat. Duis aute irure dolor in
94+
reprehenderit in voluptate velit esse cillum dolore eu
95+
fugiat nulla pariatur. Excepteur sint occaecat cupidatat
96+
non proident, sunt in culpa qui officia deserunt mollit
97+
anim id est laborum. found [Lorem Ipsum Generator]
98+
99+
100+
101+
# Section 2
102+
<ul>
103+
<li> Apple
104+
<li> Orange
105+
<li> Pineapple
106+
</ul>
107+
108+
109+
110+
[Lorem Ipsum Generator]: https://loremipsum.io/generator/
111+
```

‎.github/CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# **Contributing**
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
email, or any other method with the owners of this repository before making a change.
5+
6+
Please note we have a [code of conduct](CODE_OF_CONDUCT.md); please follow it in all your interactions with the project.
7+
8+
9+
10+
## Pull Request Process
11+
12+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
13+
build.
14+
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.
15+
3. Increase the version numbers in any examples files and the README.md to the new version that this
16+
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
17+
4. You may merge the Pull Request once you have the sign-off of two other developers, or if you
18+
do not have permission to do that, you may request the second reviewer to merge it for you.
19+
20+
21+
22+
## Issue Report Process
23+
24+
1. Go to the project's issues.
25+
2. Select the template that better fits your issue.
26+
3. Read the instructions carefully and write within the template guidelines.
27+
4. Submit it and wait for support.

‎.github/ISSUE_TEMPLATE/1-bug-report.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
name: "Bug Report"
3+
about: "Report an issue to help the project improve."
4+
title: "[Bug] "
5+
labels: "Type: Bug"
6+
assignees: caffeine-addictt
7+
8+
---
9+
10+
# Bug report
11+
Your issue may already be reported!
12+
Please check out our [active issues](https://github.com/python-thread/thread-bot/issues) before creating one.
13+
14+
15+
16+
## Expected Behavior
17+
<!--
18+
If you're describing a bug, tell us what should happen
19+
If you're suggesting a change/improvement, tell us how it should work
20+
21+
Please include screenshots and/or code snippets if applicable
22+
-->
23+
24+
25+
26+
## Current Behavior
27+
<!--
28+
If describing a bug, tell us what happens instead of the expected behavior
29+
If suggesting a change/improvement, explain the difference from current behavior
30+
31+
Please include screenshots and/or code snippets if applicable
32+
-->
33+
34+
35+
36+
## Is this a regression?
37+
<!--
38+
Did this behaviour use to work in previous versions?
39+
If yes, what is the latest version where this behaviour is not present?
40+
-->
41+
42+
43+
44+
## Possible Solution
45+
<!--
46+
Not obligatory, but suggest a fix/reason for the bug
47+
or ideas how to implement the addition or change
48+
-->
49+
50+
51+
52+
## Steps to Reproduce (for bugs)
53+
<!--
54+
Provide a link to a live example, or an unambiguous set of steps to reproduce this bug.
55+
-->
56+
1.
57+
2.
58+
3.
59+
4.
60+
61+
62+
63+
## Context
64+
<!--
65+
How has this issue affected you?
66+
What are you trying to accomplish?
67+
68+
Providing context helps us come up with a solution that is most useful in the real world.
69+
70+
Please include screenshots and/or code snippets if applicable
71+
-->
72+
73+
74+
75+
## Your Environment
76+
<!--
77+
Include as many relevant details about the environment you experienced the bug in
78+
-->
79+
* Version used:
80+
* Python version:
81+
* Link to your project:
82+
* Operating System and version (desktop or mobile):

‎.github/ISSUE_TEMPLATE/2-feature-request.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: "Feature Request"
3+
about: "Suggest an idea or possible new feature for this project."
4+
title: ""
5+
labels: "Type: Feature"
6+
assignees: caffeine-addictt
7+
8+
---
9+
10+
# Feature Request
11+
Your issue may already be reported!
12+
Please check out our [active issues](https://github.com/python-thread/thread-bot/issues) before creating one.
13+
14+
15+
16+
## Is Your Feature Request Related to an Issue?
17+
<!--
18+
If yes, provide a clear and concise description of what the problem is
19+
E.g.:
20+
Issue #
21+
I'm always frustrated when...
22+
-->
23+
24+
25+
26+
## Describe the Solution You'd Like
27+
<!--
28+
A clear and concise description of what you'd like
29+
-->
30+
31+
32+
33+
## Describe Alternatives You've Considered
34+
<!--
35+
A clear and concise description of other alternatives you have considered
36+
-->
37+
38+
39+
40+
## Additional Context
41+
<!--
42+
Any other extra context or information
43+
-->

‎.github/ISSUE_TEMPLATE/3-seccurity-report.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
name: "Security Report"
3+
about: "Report an issue to help the project improve."
4+
title: ""
5+
labels: "Type: Security"
6+
assignees: caffeine-addictt
7+
8+
---
9+
10+
<!--
11+
12+
Oh, hi there! 😄
13+
14+
To expedite issue processing, please search open and closed issues before submitting a new one.
15+
Please read our Rules of Conduct at this repository's `.github/CODE_OF_CONDUCT.md`
16+
17+
FIRST OF ALL, read this project's SECURITY.md file. Located in `.github/SECURITY.md`.
18+
19+
READ CAREFULLY IF YOUR ISSUE REPORT CONTAINS SENSIBLE OR PRIVATE DATA:
20+
(data that might be leaked or subtracted from our servers due to this
21+
security issue).
22+
23+
If this security report (or the guide on how to "identify the security bug") includes
24+
certain personal information or involves personal identifiable data, or you believe
25+
that the data that you might leak by exposing the way on how to attack the project
26+
could be considered as a data leak or could violate the privacy of any kind of
27+
data or sensible data, please do not post it here and directly email the developer:
28+
(jgracia9988@gmail.com). You should post the issue with the least amount of
29+
sensible or private data as possible to help us manage the security issue, and
30+
with the extra data sent from your email to the developer (if any), we will deeply
31+
analyze and try to fix it as fast as possible.
32+
33+
If you are in doubt about the data that you might post here (screenshots or media
34+
also, count as data), please directly email us.
35+
36+
The data that must NOT be posted here:
37+
38+
* Legal and/or full names
39+
* Names or usernames combined with other identifiers like phone numbers or email addresses
40+
* Health or financial information (including insurance information, social security numbers, etc.)
41+
* Information about political or religious affiliations
42+
* Information about race, ethnicity, sexual orientation, gender, or other identifying information that could be used for discriminatory purposes
43+
44+
-->
45+
46+
# Security Report
47+
Your issue may already be reported!
48+
Please check out our [active issues](https://github.com/python-thread/thread-bot/issues) before creating one.
49+
50+
51+
52+
## Describe the Security Issue
53+
<!--
54+
A clear and concise description of the security issue
55+
-->
56+
57+
58+
59+
## Steps to Reproduce
60+
<!--
61+
e.g.:
62+
1. Navigate to x
63+
2. Go to...
64+
3. See error
65+
-->
66+
67+
68+
69+
## Expected Behavior
70+
<!--
71+
A clear and concise description of the expected behavior
72+
-->
73+
74+
75+
76+
## Media Prove
77+
<!--
78+
If applicable, provide screenshots, videos and/or code snippets
79+
-->
80+
81+
82+
83+
## Additional Context
84+
<!--
85+
Any other extra context or information
86+
-->
87+
88+
89+
90+
### Your Environment
91+
<!--
92+
Include as many relevant details about the environment you experienced the bug in
93+
-->
94+
* Version used:
95+
* Python version:
96+
* Link to your project:
97+
* Operating System and version (desktop or mobile):

‎.github/ISSUE_TEMPLATE/4-question-support.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: "Question or Support Request"
3+
about: "Questions and requests for support."
4+
title: ""
5+
labels: "Type: Question"
6+
assignees: caffeine-addictt
7+
8+
---
9+
10+
# Question or Support Request
11+
12+
13+
14+
15+
## Describe your question or ask for support
16+
<!--
17+
A clear and concise description of what your doubt is
18+
-->
19+
20+
*

0 commit comments

Comments
 (0)