ST010: HasCodeOfConduct
Overview
| Property | Value |
|---|---|
| ID | ST010 |
| Name | HasCodeOfConduct |
| Group | structure |
| Severity | WARNING |
Description
Checks for the presence of a CODE_OF_CONDUCT.md file (or similar) in the package root directory.
A Code of Conduct establishes expectations for participant behavior and helps create a welcoming community.
What it checks
The check looks for any of these files:
CODE_OF_CONDUCT.mdCODE_OF_CONDUCT.rstCODE_OF_CONDUCT.txtCODE_OF_CONDUCTcode_of_conduct.md
Why it matters
- Community - Sets expectations for respectful interaction
- Inclusivity - Helps create a welcoming environment
- Safety - Provides a framework for handling violations
- pyOpenSci - Required for pyOpenSci review submission
How to fix
Create a CODE_OF_CONDUCT.md file. The Contributor Covenant is a widely-used template:
# 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.
## Our Standards
Examples of behavior that contributes to a positive environment:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior
may be reported to the project team. All complaints will be reviewed
and investigated promptly and fairly.You can generate a full Code of Conduct at: https://www.contributor-covenant.org/
Configuration
Skip this check
[tool.pycmdcheck]
skip = ["ST010"]CLI
pycmdcheck --skip ST010