Skip to content

Commit

Permalink
feature/mx-1561 Add code of conduct (#6)
Browse files Browse the repository at this point in the history
# Added
- add code of conduct file
  • Loading branch information
cutoffthetop authored Mar 11, 2024
1 parent 1216531 commit 725373d
Show file tree
Hide file tree
Showing 5 changed files with 95 additions and 12 deletions.
21 changes: 15 additions & 6 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

### Changes

### Deprecated

### Removed

### Fixed

### Security

## [0.1.0] - 2024-03-11

### Added

- create CHANGELOG.md
- configure dependabot updates for github-actions
- add EOF, WS and BOM githooks
Expand All @@ -18,6 +32,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- add bot user as assignee to dependabot prs
- add workflow to set pr author as assignee for user prs
- let cookiecutter workflow create PRs to run cruft update
- add code of conduct file

### Changes

Expand All @@ -30,12 +45,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- update pre-commit/requirements.txt/poetry dependencies
- set github actions dependabot to weekly

### Deprecated

### Removed

### Fixed

- do not run cve on Dependabot push events

### Security
4 changes: 2 additions & 2 deletions mex-{{ cookiecutter.project_name }}/.pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ default_language_version:
python: python3.11
repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.2.2
rev: v0.3.2
hooks:
- id: ruff
args: [--fix, --exit-non-zero-on-fix]
Expand All @@ -27,7 +27,7 @@ repos:
- id: fix-byte-order-marker
name: byte-order
- repo: https://github.com/python-poetry/poetry
rev: 1.8.1
rev: 1.8.2
hooks:
- id: poetry-check
name: poetry
Expand Down
74 changes: 74 additions & 0 deletions mex-{{ cookiecutter.project_name }}/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and
maintainers pledge to make participation in our project and our community a
harassment-free experience for everyone, regardless of age, body size, disability,
ethnicity, sex characteristics, gender identity and expression, level of experience,
education, socio-economic status, nationality, personal appearance, race, religion,
or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project team members are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in response to
any instances of unacceptable behavior.

Project team members have the right and responsibility to remove, edit, or reject
comments, commits, code, and other contributions that are not aligned to this
Code of Conduct, or to ban temporarily or permanently any contributor for other
behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when an
individual is representing the project or its community in public spaces. Examples of
representing a project or community include using an official project e-mail address,
appearing as a project maintainer, or acting as an appointed representative at an online
or offline event. Representation of a project may be further defined and clarified by
the project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
contacting the project team at [email protected]. All complaints will be reviewed and
investigated and will result in a response that is deemed necessary and appropriate to
the circumstances. The project team is obligated to maintain confidentiality with regard
to the reporter of an incident. Further details of specific enforcement policies may be
posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may
face temporary or permanent repercussions as determined by project, departmental
or organizational leadership roles.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

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

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
6 changes: 3 additions & 3 deletions mex-{{ cookiecutter.project_name }}/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ python = "^3.11"
[tool.poetry.group.dev.dependencies]
black = "^24.2.0"
ipdb = "^0.13.13"
mypy = "^1.8.0"
pytest = "^8.0.2"
mypy = "^1.9.0"
pytest = "^8.1.1"
pytest-cov = "^4.1.0"
pytest-random-order = "^1.1.1"
ruff = "^0.2.2"
ruff = "^0.3.2"
sphinx = "^7.2.6"

[tool.poetry.scripts]
Expand Down
2 changes: 1 addition & 1 deletion mex-{{ cookiecutter.project_name }}/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
cruft==2.15.0
poetry==1.8.1
poetry==1.8.2
pre-commit==3.6.2
wheel==0.42.0

0 comments on commit 725373d

Please sign in to comment.