Skip to content

Commit

Permalink
Add pre-commit hook and CI with mdformat (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
lysnikolaou authored Nov 21, 2024
1 parent b2a605c commit 0e234af
Show file tree
Hide file tree
Showing 6 changed files with 142 additions and 41 deletions.
19 changes: 19 additions & 0 deletions .github/workflows/pre-commit.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Run pre-commit and autofix

on:
pull_request:
branches:
- main

jobs:
pre-commit:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.12

- uses: pre-commit/[email protected]
- uses: pre-commit-ci/[email protected]
if: always()
1 change: 1 addition & 0 deletions .mdformat.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
wrap = 90
13 changes: 13 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: end-of-file-fixer
- id: trailing-whitespace
- id: check-yaml
- repo: https://github.com/executablebooks/mdformat
rev: 0.7.19
hooks:
- id: mdformat
additional_dependencies:
- mdformat-gfm
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,33 @@
# PyGreece Community Knowledge Base

Connecting Python enthusiasts worldwide – fostering collaboration, inclusivity, and community growth.
Connecting Python enthusiasts worldwide – fostering collaboration, inclusivity, and
community growth.

## Background

Welcome to the Community repo of PyGreece. The Community repo stands as the knowledge base of the PyGreece Community. More detailed, it's an attempt to share with the world all the recourses and the processes we follow.
Welcome to the Community repo of PyGreece. The Community repo stands as the knowledge base
of the PyGreece Community. More detailed, it's an attempt to share with the world all the
recourses and the processes we follow.

## Sharing Knowledge

As mentioned above, we aim to share all resources we have inside this repository. We'll share detailed instructions on how someone can contribute to the repo soon :)
As mentioned above, we aim to share all resources we have inside this repository. We'll
share detailed instructions on how someone can contribute to the repo soon :)

## Greek Translation of the Python Documentation

One of our main project is the translation of the Python docs to the Greek language. You can find more information about the project [here](https://github.com/pygreece/python-docs-gr/).
One of our main project is the translation of the Python docs to the Greek language. You
can find more information about the project
[here](https://github.com/pygreece/python-docs-gr/).

## Join the PyGreece Discord Server

The PyGreece discord server aims to connect all the members of the greek python community in one place. You can join the server by following this link: https://discord.gg/gWcXmDw8Yj
The PyGreece discord server aims to connect all the members of the greek python community
in one place. You can join the server by following this link:
https://discord.gg/gWcXmDw8Yj

## PyGreece Code of Conduct

Please read carefully our code of conduct: [GR](https://github.com/pygreece/community/blob/update-readme/code-of-conduct/greek.md) / [EN](https://github.com/pygreece/community/blob/update-readme/code-of-conduct/english.md)
Please read carefully our code of conduct:
[GR](https://github.com/pygreece/community/blob/update-readme/code-of-conduct/greek.md) /
[EN](https://github.com/pygreece/community/blob/update-readme/code-of-conduct/english.md)
60 changes: 43 additions & 17 deletions code-of-conduct/english.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,72 @@
# PyGreece Code of Conduct

PyGreece is a community of developers that aims to network and collaborate with all Python developer communities in Greece.
PyGreece is a community of developers that aims to network and collaborate with all Python
developer communities in Greece.

We support the participation of every member of the Python community and we want all individuals who participate to have an enjoyable and satisfying experience. Consequently, all participants, speakers, members, organizers, and volunteers at any PyGreece event must abide by the following Code of Conduct.
We support the participation of every member of the Python community and we want all
individuals who participate to have an enjoyable and satisfying experience. Consequently,
all participants, speakers, members, organizers, and volunteers at any PyGreece event must
abide by the following Code of Conduct.

## Our community

Some behaviors that describe a member of the PyGreece community are:

- We are always open to partnerships. Community members should always be open to collaboration with other members, new volunteers/developers.
- We are always open to partnerships. Community members should always be open to
collaboration with other members, new volunteers/developers.
- We focus on what is best for the community.
- We respect the processes set out in the community and work within them.
- We recognize time and effort. We respect the volunteer efforts that govern the Python community. We are thoughtful when referring to the efforts of others.
- We show empathy to other community members. We are careful in our communications, whether in person or online, and are considerate when approaching differing viewpoints.
- We respect others, their positions, their abilities, their commitments and their efforts. We are receptive to constructive feedback and criticism, as the experiences and skills of other members contribute to our overall efforts.
- We graciously accept constructive criticism. When we disagree, we are courteous in presenting our issues.
- We use welcoming and inclusive language. We welcome all who wish to participate in our activities, fostering an environment where everyone can participate and everyone can make a difference.
- We recognize time and effort. We respect the volunteer efforts that govern the Python
community. We are thoughtful when referring to the efforts of others.
- We show empathy to other community members. We are careful in our communications,
whether in person or online, and are considerate when approaching differing viewpoints.
- We respect others, their positions, their abilities, their commitments and their
efforts. We are receptive to constructive feedback and criticism, as the experiences and
skills of other members contribute to our overall efforts.
- We graciously accept constructive criticism. When we disagree, we are courteous in
presenting our issues.
- We use welcoming and inclusive language. We welcome all who wish to participate in our
activities, fostering an environment where everyone can participate and everyone can
make a difference.

## Our values

Every member of our community has the right to have their identity respected. The Python community is dedicated to providing a positive experience for everyone, regardless of age, gender identity and expression, sexual orientation, disability, physical appearance, body size, ethnicity, race, religion (or lack thereof), education, cultural and cognitive differences, or socioeconomic status.
Every member of our community has the right to have their identity respected. The Python
community is dedicated to providing a positive experience for everyone, regardless of age,
gender identity and expression, sexual orientation, disability, physical appearance, body
size, ethnicity, race, religion (or lack thereof), education, cultural and cognitive
differences, or socioeconomic status.

## Examples of inappropriate behavior

- Harassment of any person in any form.
- Intentional bullying, harassment or stalking.
- Recording or taking screenshots of online activity for the purpose of harassment.
- Posting personal information of others, such as physical or email address, without express permission.
- Posting personal information of others, such as physical or email address, without
express permission.
- Threats of violence or verbal abuse directed at another person.
- Inciting violence or harassment towards any person, including encouraging a person to commit suicide or self-harm.
- Inciting violence or harassment towards any person, including encouraging a person to
commit suicide or self-harm.
- Creating additional online accounts for the purpose of harassing another person.
- Language and images in the online community on discord or in any venue, including speech, that sexualizes, insults, demeans or attacks groups or specific individuals.
- Language and images in the online community on discord or in any venue, including
speech, that sexualizes, insults, demeans or attacks groups or specific individuals.
- Insults, slurs or jokes based on stereotypes.
- Unwelcome sexual attention or advances.
- Persistent disruption of online community discord discussions, presentations or other events.
- Persistent disruption of online community discord discussions, presentations or other
events.
- Continued personal communication after requests to discontinue such communication.
- Other behavior that is inappropriate for a professional audience that includes individuals from many different backgrounds.
- Other behavior that is inappropriate for a professional audience that includes
individuals from many different backgrounds.

Community members who are asked to stop any inappropriate behavior are expected to comply immediately.
Community members who are asked to stop any inappropriate behavior are expected to comply
immediately.

## Consequences

If a participant engages in behavior that violates this Code of Conduct, the PyGreece organizing team may take such action as it deems appropriate, including warning the offender or banning the offender (for life or for a specified period of time) from the community and community events.
If a participant engages in behavior that violates this Code of Conduct, the PyGreece
organizing team may take such action as it deems appropriate, including warning the
offender or banning the offender (for life or for a specified period of time) from the
community and community events.

**Thank you for helping to make PyGreece a welcoming and friendly community for everyone.**
**Thank you for helping to make PyGreece a welcoming and friendly community for
everyone.**
Loading

0 comments on commit 0e234af

Please sign in to comment.