Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Code of Conduct and linked it in README.md #61

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
# TwinTrim Contributor Code of Conduct

## Overview

We aim to foster a collaborative, inclusive, and welcoming community within **twinTrim**. All contributors are expected to help create a positive experience for everyone, regardless of background, identity, or experience.

## Expected Behavior

Contributors are expected to:

- Be kind, respectful, and considerate to others.
- Use inclusive and welcoming language.
- Offer constructive feedback, understanding that different perspectives exist.
- Value the experiences and input of other community members.
- Prioritize the needs of the community and the project as a whole.

## Unacceptable Behavior

The following actions will not be tolerated:

- Any form of harassment, including derogatory comments, insults, or threats.
- Use of sexualized language or unwelcome advances.
- Personal attacks, trolling, or political arguments that derail discussions.
- Publishing or sharing private information of others without consent.
- Any behavior that creates a hostile or unsafe environment.

## Responsibility of Maintainers
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if its a code of conduct for contributors (line #1), why add this point here


Maintainers are responsible for ensuring that the Code of Conduct is upheld by all participants in the project. This includes:

- Clarifying standards for acceptable behavior.
- Responding to reports of unacceptable behavior swiftly and fairly.
- Removing or blocking individuals who engage in harmful or disruptive behavior.
- Facilitating a healthy and inclusive atmosphere in all project spaces (repositories, forums, etc.).

## Reporting Issues

If you observe or experience any behavior that violates this Code of Conduct, please reach out to the project maintainers through [GitHub Issues](https://github.com/your-repo/twinTrim/issues) or directly via private communication (maintainers' contact to be decided).

All reports will be kept confidential, and every effort will be made to address issues promptly and fairly.

You can also refer to the [Contributor Covenant Reporting Guidelines](https://www.contributor-covenant.org) for more details on how to handle reports.

## Consequences for Violations

Depending on the severity of the violation, maintainers may take one or more of the following actions:

- Issue a private or public warning.
- Temporarily or permanently ban the individual from project spaces.
- Revoke access to specific project features or repositories.

## Appeals Process

Anyone subject to disciplinary action may appeal by contacting the project maintainers with a clear explanation of why the decision should be reconsidered. A review will be conducted to ensure fairness.

## Commitment to Confidentiality

All reports will be treated confidentially. We value your privacy and will only disclose information to those involved in addressing the reported issue.

## Attribution

This Code of Conduct is based on the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0.

---

By contributing to **twinTrim**, you agree to adhere to this Code of Conduct and help maintain a positive, welcoming community for everyone.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,10 @@ If you haven't installed Poetry yet, you can do so by following the instructions

Contributions are welcome! Whether you have ideas for improving the internal workings of TwinTrim, such as optimizing performance or refining algorithms, or you want to enhance the user interface of the CLI tool for a better user experience, your input is valuable. Please fork the repository and submit a pull request with your improvements or new features.

## Code of Conduct

We have adopted a [Code of Conduct](./CODE_OF_CONDUCT.md) to foster an inclusive and welcoming environment. Please read and follow it.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Expand Down
Loading