Skip to content

Commit

Permalink
added .github dir, guidelines, changed tests, vscode tasks
Browse files Browse the repository at this point in the history
  • Loading branch information
Simoso68 committed Aug 26, 2023
1 parent d589e03 commit 59b2648
Show file tree
Hide file tree
Showing 9 changed files with 158 additions and 4 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @Simoso68
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Bug Report

## General information

### Operating System
<!--Answer in the text field below-->
```
```

### Python Version
<!--Answer in the text field below-->
```
```

### Octopype Module Version
<!--Answer in the text field below-->
```
```

### Requests Module Version
<!--Answer in the text field below-->
```
```

## Explanation

<!--Explain what the bug causes for issues, if you want, you can provide screenshots-->

## Steps to reproduce
<!--Explain the steps on how to reproduce the issue using the given format below-->
<!--If you want, you can provide screenshots-->

- Step 1: You need to ...
- Step 2: And then you need to ...

## Additional information
<!--Additional information about the issue-->
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Feature Request

## Feature explanaition
<!--Explain, what feature you want to add, how it should be named, what it can do, etc.-->
<!--Go in to as much depth as possible, so we can understand the requested feature and the given reasons, why we should add it-->

## Code
<!--Code snippets you provided, on how the feature could be made-->
<!--You don't need to provide code snippets, if you can not-->
<!--If the given code is not a small snippet, but the entire feature itself, you should open a pull request-->

## Additional information
<!--Additional information about the requested feature-->
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ __pycache__
test.py
/dist
/build
/octopype.egg-info
/octopype.egg-info
.pytest_cache
3 changes: 2 additions & 1 deletion .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
"type": "shell",
"command": "make",
"args": [
"build"
"build",
"-B"
],
"windows": {
"command": "echo Sadly, there is no make in Windows."
Expand Down
74 changes: 74 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## 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 of
any kind
* 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

## 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.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Contributing Guidelines

## Allowed types of contributed code

- Source code
- Testing code
- Files for documentation, etc. such as this one

## We do NOT accept

- Malicious code
- Code, which is insulting to any kind of person or group
- Useless code additions such as simply adding comments to the source code

## Malicious code

We define code as malicious, when it:

- Doesn't behave like the user expects in a negative way
- Steals private information
- Encrypts data
- Targets people with ads, phising mails, spam
2 changes: 2 additions & 0 deletions pytest.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[pytest]
python_files=tests/*.py
3 changes: 1 addition & 2 deletions tests/getbio.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import octopype
import sys

github = octopype.OctoPype(sys.argv[1])
github = octopype.OctoPype(open("tests/token.txt").read())

print(github.account.info().bio)

0 comments on commit 59b2648

Please sign in to comment.