mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-03-26 03:03:32 +01:00
Refactored README.md
This commit is contained in:
parent
d84ffc375b
commit
cf22ff49fc
9
06_DONATE.md
Normal file
9
06_DONATE.md
Normal file
@ -0,0 +1,9 @@
|
||||
# Support Us
|
||||
|
||||
CyMaIS is a transformative tool designed to redefine IT infrastructure setup for organizations and individuals alike. Your contributions directly support the ongoing development and innovation behind CyMaIS, ensuring that it continues to grow and serve its community effectively.
|
||||
|
||||
If you enjoy using CyMaIS and would like to contribute to its improvement, please consider donating. Every contribution, no matter the size, helps us maintain and expand this project.
|
||||
|
||||
[](https://github.com/sponsors/kevinveenbirkenbach) [](https://www.patreon.com/c/kevinveenbirkenbach) [](https://buymeacoffee.com/kevinveenbirkenbach) [](https://s.veen.world/paypaldonate)
|
||||
|
||||
Thank you for your support!
|
||||
38
CODE_OF_CONDUCT.md
Normal file
38
CODE_OF_CONDUCT.md
Normal file
@ -0,0 +1,38 @@
|
||||
# Code of Conduct
|
||||
|
||||
In order to foster a welcoming, open, and respectful community for everyone, we expect all contributors and participants in the CyMaIS project to abide by the following Code of Conduct.
|
||||
|
||||
## Our Pledge
|
||||
|
||||
We are committed to creating a friendly, safe, and inclusive environment for all members of our community—regardless of age, race, gender, sexual orientation, disability, religion, or any other status. We pledge to treat everyone with respect and courtesy.
|
||||
|
||||
## Expected Behavior
|
||||
|
||||
- **Be Respectful:** Communicate and collaborate with courtesy, empathy, and respect. Listen to others’ opinions and value their input.
|
||||
- **Be Inclusive:** Welcome contributions from all backgrounds and experiences. Encourage diverse perspectives and engage in constructive dialogue.
|
||||
- **Practice Professionalism:** Use clear and professional language in all communications. Maintain focus on ideas and project goals rather than personal attributes.
|
||||
- **Be Collaborative:** Foster an environment where everyone can contribute freely. Offer help and constructive feedback, and work together towards common goals.
|
||||
- **Respect Boundaries:** Understand and honor others’ personal and professional boundaries.
|
||||
|
||||
## Unacceptable Behavior
|
||||
|
||||
- **Harassment and Discrimination:** Any form of harassment, hate speech, or discriminatory behavior will not be tolerated.
|
||||
- **Intimidation and Threats:** Verbal or written intimidation, threats, or aggressive behavior toward any community member is strictly prohibited.
|
||||
- **Personal Attacks:** Avoid personal insults or demeaning comments toward any contributor or participant.
|
||||
- **Exclusionary Behavior:** Do not engage in behaviors or comments that might exclude or isolate community members.
|
||||
|
||||
## Reporting and Enforcement
|
||||
|
||||
If you experience or witness any behavior that violates this Code of Conduct, please report it promptly. Reports should be sent to kevin@veen.world. All reports will be treated with discretion and confidentiality.
|
||||
|
||||
Our project maintainers and community leaders will review all reports and take appropriate action, which may include warnings, temporary suspension, or permanent expulsion from the community if necessary.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies to all spaces managed by the CyMaIS project, including GitHub repositories, mailing lists, chat rooms, and other communication channels.
|
||||
|
||||
## Acknowledgment
|
||||
|
||||
By participating in the CyMaIS project, you agree to adhere to this Code of Conduct. We appreciate your cooperation in helping us build a positive and productive community.
|
||||
|
||||
Thank you for contributing to a safe and inclusive CyMaIS community!
|
||||
57
CONTRIBUTING.md
Normal file
57
CONTRIBUTING.md
Normal file
@ -0,0 +1,57 @@
|
||||
# Contributing
|
||||
|
||||
Thank you for your interest in contributing to CyMaIS! We welcome contributions from the community to help improve and enhance this project. Your input makes the project stronger and more adaptable to a wide range of IT infrastructure needs.
|
||||
|
||||
## How to Contribute
|
||||
|
||||
There are several ways you can help:
|
||||
- **Reporting Issues:** Found a bug or have a feature request? Please open an issue on our [GitHub Issues page](https://github.com/your-repo-link/issues) with a clear description and steps to reproduce the problem.
|
||||
- **Code Contributions:** If you'd like to contribute code, fork the repository, create a new branch for your feature or bug fix, and submit a pull request. Ensure your code adheres to our coding style and includes tests where applicable.
|
||||
- **Documentation:** Improving the documentation is a great way to contribute. Whether it's clarifying an existing section or adding new guides, your contributions help others understand and use CyMaIS effectively.
|
||||
- **Financial Contributions:** If you appreciate CyMaIS and want to support its ongoing development, consider making a financial contribution. For more details, please see our [06_DONATE.md](06_DONATE.md) file.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
All contributors are expected to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). Please review it to ensure that our community remains welcoming and respectful.
|
||||
|
||||
## Pull Request Guidelines
|
||||
|
||||
Before submitting a pull request, please ensure that:
|
||||
- Your code is well-documented and follows the project's coding standards.
|
||||
- All tests pass and, if necessary, new tests are added to cover your changes.
|
||||
- The commit messages are clear and descriptive.
|
||||
- The relevant documentation is updated to reflect your changes.
|
||||
|
||||
## Reporting Issues
|
||||
|
||||
When reporting an issue, please include:
|
||||
- A descriptive title and detailed explanation.
|
||||
- Steps to reproduce the issue.
|
||||
- Information about your environment (e.g., operating system, Docker version, Ansible version, etc.).
|
||||
- Any relevant logs or error messages.
|
||||
|
||||
## Coding Style
|
||||
|
||||
Please follow these guidelines when contributing code:
|
||||
- Write clean, readable code that integrates with the existing codebase.
|
||||
- Use descriptive names for variables and functions.
|
||||
- Comment your code where necessary, especially in complex sections.
|
||||
- Format your code according to the project's style guidelines.
|
||||
|
||||
## License and Commercial Use
|
||||
|
||||
CyMaIS is primarily designed for private use. Commercial use of CyMaIS is not permitted without a proper licensing agreement. By contributing to this project, you agree that your contributions will be licensed under the same terms as the rest of the project.
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. **Fork** the repository on GitHub.
|
||||
2. **Clone** your fork to your local machine.
|
||||
3. **Create** a new branch for your feature or bug fix.
|
||||
4. **Implement** your changes and commit them with clear messages.
|
||||
5. **Push** your branch to GitHub and open a pull request.
|
||||
|
||||
## Community and Support
|
||||
|
||||
If you have any questions or need help, feel free to open an issue or join our community discussions. We appreciate your efforts and are here to support you.
|
||||
|
||||
Thank you for contributing to CyMaIS and helping us build a better, more efficient IT infrastructure solution!
|
||||
@ -1,6 +1,4 @@
|
||||
# CyMaIS - Cyber Master Infrastructure Solution
|
||||
[](https://github.com/sponsors/kevinveenbirkenbach) [](https://www.patreon.com/c/kevinveenbirkenbach) [](https://buymeacoffee.com/kevinveenbirkenbach) [](https://s.veen.world/paypaldonate)
|
||||
|
||||
|
||||
<img src="https://cybermaster.space/wp-content/uploads/sites/7/2023/12/logo_cymais.png" width="300" style="float: right; margin-left: 10px;">
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user