Skip to content

Commit 4fa2831

Browse files
caffeine-addicttcaffeine-addictt
authored
Merge pull request #1 from python-thread/dev
Migration from threadCore
2 parents dfb76a2 + d08cbad commit 4fa2831

29 files changed

+1783
-1
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: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
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 one of the following depending on the type of change made.
61+
62+
- `feat:` when a new feature is introduced with the changes.
63+
- `fix:` when a bug fix has occurred.
64+
- `chore:` for changes that do not relate to a fix or feature and do not modify *source* or *tests*. (like updating dependencies)
65+
- `refactor:` for refactoring code that neither fixes a bug nor adds a feature.
66+
- `docs:` when changes are made to documentation.
67+
- `style:` when changes that do not affect the code, but modify formatting.
68+
- `test:` when changes to tests are made.
69+
- `perf:` for changes that improve performance.
70+
- `ci:` for changes that affect CI.
71+
- `build:` for changes that affect the build system or external dependencies.
72+
- `revert:` when reverting changes.
73+
74+
Commit messages are also to begin with an uppercase character. Below list some example commit messages.
75+
76+
```sh
77+
git commit -m "docs: Added README.md"
78+
git commit -m "revert: Removed README.md"
79+
git commit -m "docs: Moved README.md"
80+
```
81+
82+
83+
84+
## Markdown Guidelines
85+
Currently, documentation for this project resides in markdown files.
86+
- Headings are to be separated with 3 lines
87+
- Use of HTML comments is appreciated
88+
- Use of HTML is permitted
89+
- [reference style links](https://www.markdownguide.org/basic-syntax/#reference-style-links) are not required by are appreciated
90+
- Exceedingly long lines are to be broken
91+
- The indents are to be two spaces
92+
93+
```markdown
94+
<!--example markdown document-->
95+
# Section
96+
Lorem ipsum dolor sit amet, consectetur adipiscing elit,
97+
sed do eiusmod tempor incididunt ut labore et dolore
98+
magna aliqua. Ut enim ad minim veniam, quis nostrud
99+
exercitation ullamco laboris nisi ut aliquip ex ea
100+
commodo consequat. Duis aute irure dolor in
101+
reprehenderit in voluptate velit esse cillum dolore eu
102+
fugiat nulla pariatur. Excepteur sint occaecat cupidatat
103+
non proident, sunt in culpa qui officia deserunt mollit
104+
anim id est laborum. found [Lorem Ipsum Generator]
105+
106+
107+
108+
# Section 2
109+
<ul>
110+
<li> Apple
111+
<li> Orange
112+
<li> Pineapple
113+
</ul>
114+
115+
116+
117+
[Lorem Ipsum Generator]: https://loremipsum.io/generator/
118+
```

‎.github/CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎.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-cli/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):

0 commit comments

Comments
 (0)