From 2af2bd2cf21c6b82697baed66d671cd55d1106b5 Mon Sep 17 00:00:00 2001 From: Harm Manders Date: Mon, 9 Dec 2024 18:39:40 +0100 Subject: [PATCH] added CLA, CoC and Contribution guide --- docs/CLA.md | 50 +++++++++++++++++++++++++++++++++ docs/CONTRIBUTING.md | 39 ++++++++++++++++++++++++++ docs/CoC.md | 66 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 155 insertions(+) create mode 100644 docs/CLA.md create mode 100644 docs/CONTRIBUTING.md create mode 100644 docs/CoC.md diff --git a/docs/CLA.md b/docs/CLA.md new file mode 100644 index 00000000..93019d5f --- /dev/null +++ b/docs/CLA.md @@ -0,0 +1,50 @@ +# Contributor License Agreement (CLA) + +## 1. Definitions + +- **"You"**: The individual or legal entity making the Contribution. +- **"Contribution"**: Any work, including code, documentation, or other material, submitted to the project by You. +- **"Project"**: Shieldmaiden, a product distributed by Harmless Key under the Functional Source License (FSL). that You are contributing to. +- **"Maintainer"**: Harmless Key, the entity responsible for managing the Shieldmaiden project. The individual or entity responsible for managing the Project. + +--- + +## 2. Grant of Copyright + +By submitting a Contribution to the Project, You agree to transfer and assign all right, title, and interest in the copyright of the Contribution to the Maintainer. This ensures the Maintainer has the sole ownership of the Contribution. + +--- + +## 3. Contributor's Representations + +By submitting a Contribution, You represent and warrant that: + +1. **Original Work**: The Contribution is Your original creation or You have sufficient rights to grant the rights described in this agreement. +2. **No Conflict**: The Contribution does not violate the rights of any third party, including but not limited to copyright, patent, or trade secret rights. +3. **No Restriction**: The Contribution is not subject to any license or other restriction that would conflict with this agreement or the Project's licensing terms. + +--- + +## 4. License to Contributors + +The Maintainer grants You a perpetual, worldwide, non-exclusive, royalty-free license to use Your Contribution as part of the Project under the terms of the Functional Source License (FSL). + +--- + +## 5. Submission Process + +You agree that by submitting a Contribution, either via pull request, patch, or other form of communication, You accept and agree to the terms of this CLA. + +--- + +## 6. Miscellaneous + +1. **Governing Law**: This agreement shall be governed by and interpreted in accordance with the laws of the European Union (EU), without regard to conflict of law principles.. +2. **Entire Agreement**: This agreement constitutes the entire understanding between You and the Maintainer regarding Contributions to the Project. +3. **Severability**: If any provision of this agreement is found to be invalid or unenforceable, the remaining provisions shall remain in full force and effect. + +--- + +## Acknowledgment + +By submitting a Contribution, You acknowledge that You have read and understood this agreement, and You agree to be bound by its terms. diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 00000000..95edd6f3 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,39 @@ +# Contributing to Shieldmaiden + +Thank you for your interest in contributing to Shieldmaiden! We welcome contributions of all kinds, including code, documentation, and suggestions for improvements. + +--- + +## How to Contribute + +1. **Fork the Repository**: Create a personal copy of the repository to work on. + - Request access to our Contributors Guide for more instructions via [Discord](https://discord.gg/fhmKBM7). +2. **Make Your Changes**: Implement your changes in a feature branch. +3. **Submit a Pull Request**: Open a pull request to propose your changes to the main repository. + +--- + +## Contributor License Agreement (CLA) + +By submitting a pull request, you agree to the terms of the [Contributor License Agreement (CLA)](./CLA.md). This means: + +- You transfer and assign all copyright to Harmless Key for your contribution. +- Your contribution is licensed under the same terms as Shieldmaiden. + +Please read the CLA carefully before submitting your first pull request. + +--- + +## Code of Conduct + +We expect all contributors to adhere to our [Code of Conduct](./CoC.md). Be respectful, collaborative, and constructive in your interactions. + +--- + +## Additional Notes + +- Ensure your commits include a clear and descriptive message. +- If your pull request addresses a specific issue, reference it in the description (e.g., "Fixes #123"). +- For large changes, consider discussing them with the maintainers first by opening an issue. + +Thank you for helping make Shieldmaiden better! diff --git a/docs/CoC.md b/docs/CoC.md new file mode 100644 index 00000000..4a5753bf --- /dev/null +++ b/docs/CoC.md @@ -0,0 +1,66 @@ +# Code of Conduct + +## Introduction + +At Harmless Key, we are committed to providing a welcoming, inclusive, and harassment-free experience for everyone contributing to or using Shieldmaiden. This Code of Conduct outlines our expectations for contributors and the steps to report unacceptable behavior. + +--- + +## Our Standards + +We expect all participants to: + +- **Be Respectful:** Show empathy and consideration for others, regardless of differences in opinion or background. +- **Be Constructive:** Offer helpful feedback and work collaboratively to resolve issues. +- **Use Inclusive Language:** Avoid language or imagery that is discriminatory, derogatory, or offensive. +- **Foster a Positive Environment:** Support and encourage fellow contributors to do their best work. + +Unacceptable behaviors include: + +- Harassment, discrimination, or derogatory comments based on race, gender, sexual orientation, disability, or any other protected category. +- Personal attacks, threats, or intimidation. +- Publishing private information without consent. +- Sustained disruption of discussions or workspaces. + +--- + +## Scope + +This Code of Conduct applies to all contributors and users of Shieldmaiden across project spaces, including: + +- Code repositories. +- Pull requests and issue discussions. +- Community forums, chats, and mailing lists. +- Events or meetings related to the project. + +--- + +## Reporting Issues + +If you witness or experience behavior that violates this Code of Conduct: + +1. Contact the project maintainers at (contact\@harmlesskey.com). +2. Provide as much detail as possible, including: + - Date, time, and location of the incident. + - Description of the behavior. + - Names of individuals involved (if known). + +All reports will be handled with discretion and confidentiality. + +--- + +## Enforcement + +Project maintainers are responsible for enforcing this Code of Conduct and may take the following actions: + +1. Issue a warning to the individual. +2. Temporarily or permanently ban the individual from project spaces. +3. Remove inappropriate contributions or comments. + +The maintainers' decisions are final and will be communicated clearly. + +--- + +## Acknowledgment + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.