Skip to content

Commit

Permalink
Resolve "Add CODEOWNERS, SECURITY.md, CODE_OF_CONDUCT.md, issue templ…
Browse files Browse the repository at this point in the history
…ates, and more"
  • Loading branch information
btschwertfeger committed Jan 6, 2025
1 parent 9107e82 commit 7e8c5af
Show file tree
Hide file tree
Showing 14 changed files with 377 additions and 11 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @btschwertfeger
127 changes: 127 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
# 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, socioeconomic status,
nationality, personal appearance, race, 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

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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, and will communicate reasons for moderation
decisions when appropriate.

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

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

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

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
93 changes: 93 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# Welcome to kraken-infinity-grid contributing guide

Thank you for investing your time in contributing to the
[kraken-infinity-grid](https://github.com/btschwertfeger/kraken-infinity-grid/)
project! 🔥

Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community
approachable and respectable.

If you have any questions, comments, suggestions or general topics, please feel
free to open or join a thread at
[kraken-infinity-grid/discussions](https://github.com/btschwertfeger/kraken-infinity-grid/discussions).
We are looking forward to nice conversations, strategy exchange and an knowledge
transfer!

## Getting started 🚀

In this guide you will get an overview of the contribution workflow from opening
an issue, creating a PR, reviewing, and merging the PR.

### Issues

#### Create a new issue

If you have an issue that's not yet listed in the troubleshooting section of
[README.md](https://github.com/btschwertfeger/kraken-infinity-grid#readme) or in
[documentation](https://kraken-infinity-grid.readthedocs.io/en/stable), feel
free to create a new
[issue](https://github.com/btschwertfeger/kraken-infinity-grid/issues) if there
is no similar one listed among the existing ones. Also, for any features that
are missing, this is the right place to request them.

#### Solve an issue

Scan through our [existing
issues](https://github.com/btschwertfeger/kraken-infinity-grid/issues) to find
one that interests you. If the future brings more and more features or issues -
you can also filter for specific `labels`.

### Make Changes

1. Fork the repository and clone your fork locally.

```bash
git clone https://github.com/<username>/kraken-infinity-grid.git
```

2. Install the provided [pre-commit](https://pre-commit.com/) hooks within the
repository and make sure that all hooks run through, before pushing changes.

```bash
cd kraken-infinity-grid
kraken-infinity-grid~$: pre-commit install
```

3. Create a new branch and start implementing your changes.

In the project provides a `Makefile` which offers many shortcuts to execute
different commands. For example, you can use `make test` to run all unit
tests or `make build` to build the package. `make dev` installs the
kraken-infinity-grid in editable state into the current environment. However,
for development it is recommended to set up a virtual environment first.

### Commit your updates 🎬

Once you're happy or reached some minor goal - commit the changes. Please take
care to address **all** requirements of the [self-review
checklist](./.github/self-review.md) before creating a PR to speed up the review
process. ⚡️

### Pull Request

When you're finished with the changes, create a pull request.

- All checks of the [self-review checklist](./.github/self-review.md) must be
addressed.
- Don't forget to link PR to an issue or create one to link if there is no
existing issue.
- You may asked for changes to be made before a PR can be merged, either using
_suggested changes_ or pull request _comments_. You can make any other changes
in your fork, then commit them to your branch.
- As you update your PR and apply changes, mark each conversation as resolved.

### Your PR is merged! 🏅

Great! We're happy and proud of any contribution made on this project. So you
may want to start to work on the next issue? 🔥

---

This file is based on the
[CONTRIBUTING.md](https://github.com/github/docs/blob/v1.0.1/CONTRIBUTING.md)
file provided by [GitHub Docs](https://github.com/github/docs).
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Bug report
about: Create a report to help us improve
title: ""
labels: "Bug"
assignees: ""
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Installing '...'
2. Create environment '...'
3. Run command '...'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots and code snippets**
If applicable, add screenshots or code snippets to help explain your problem.
Please _do not upload any files_.

**Environment (please complete the following information):**

- OS: [e.g. Ubuntu 24.04]
- Python [e.g. 3.11, 3.12, 3.13]
- kraken-infinity-grid version [e.g. 1.0.0]

**Additional context**
Add any other context about the problem here.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Feature request
about: Suggest an idea for this project
title: ""
labels: "Feature"
assignees: ""
---

**Is your feature request related to a problem? Please describe.**

A clear and concise description of what the problem is. Ex. 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.
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: General question
about: Help us to understand your findings
title: ""
labels: "Question"
assignees: ""
---

There are no stupid questions.
21 changes: 21 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Security Policy

## Reporting Security Vulnerabilities

At kraken-infinity-grid, we take security seriously. We welcome and encourage
responsible disclosure of security vulnerabilities. If you believe you've found
a security vulnerability within our project, please report it immediately.

## How to Report a Security Vulnerability

To report a security vulnerability, please send an email to
[[email protected]](mailto:[email protected]) with a detailed
description of the vulnerability. We kindly request that you refrain from
disclosing the vulnerability publicly until we have had an opportunity to
address it.

## Our Commitment

We are committed to promptly addressing and resolving any security
vulnerabilities reported to us. We will investigate all reports and take
appropriate action to protect the security of our users and their data.
4 changes: 0 additions & 4 deletions .github/dependabot.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,3 @@ updates:
directory: "/"
schedule:
interval: "weekly"
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "weekly"
16 changes: 16 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Summary

A short summary into the pull request including the reason for that change.

## Changes / Features

What has being changed - provide code snippets, examples, screenshots, lists -
any kind of information hat helps to understand the update.

**Make sure to address all topics of the [self-review
checklist](https://github.com/btschwertfeger/kraken-infinity-grid/blob/master/.github/self-review.md).**

Closes: Don't forget to link an existing issue for your change. If there is no
open issue for your change - create one to make it more likely that his update
will be accepted:
[kraken-infinity-grid/issues/new/choose](https://github.com/btschwertfeger/kraken-infinity-grid/issues/new/choose).
4 changes: 2 additions & 2 deletions .github/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ changelog:
labels:
- Bug
- bug
- title: Other Changes
- title: Other Changes 📝
labels:
- "*"
exclude:
labels:
- dependencies
- github_actions
- title: 👒 Dependencies
- title: Dependencies 👒
labels:
- dependencies
- github_actions
22 changes: 22 additions & 0 deletions .github/self-review.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Self review checklist ✅

Before creating a pull request you should check the following requirements that
must be addressed before a PR will be accepted.

- [ ] **All** pre-commit hooks must run through - successfully.
- [ ] Make sure that the changes confirm the coding style of the
[kraken-infinity-grid](https://github.com/btschwertfeger/kraken-infinity-grid).
Most issues will be resolve through the pre-commit hooks.
- [ ] Also take care to follow the community guidelines and the [Code of
Conduct](./CODE_OF_CONDUCT.md).
- [ ] Self-review your changes to detect typos, syntax errors, and any kind of
unwanted behavior.
- [ ] If you changed the source code you have to **ensure that all unit tests
run through**. If you added a new function you also have to **write a
test** for that.
- [ ] Take your time to prepare your code before creating a PR. A good PR will
save a lot of time for everyone.
- [ ] There are several workflows/actions within this repository. Relevant
workflows must be run successfully within your fork. Actions must be
enabled within the fork, so that workflows can run within the context of a
PR.
4 changes: 2 additions & 2 deletions .github/workflows/cicd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ jobs:
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest]
python-version: ["3.11"]
os: [ubuntu-latest, windows-latest, macos-latest]
python-version: ["3.11", "3.12", "3.13"]
with:
os: ${{ matrix.os }}
python-version: ${{ matrix.python-version }}
Expand Down
Loading

0 comments on commit 7e8c5af

Please sign in to comment.