diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md index 72cf5bf..9c2e2c6 100644 --- a/docs/CODE_OF_CONDUCT.md +++ b/docs/CODE_OF_CONDUCT.md @@ -3,23 +3,27 @@ status: draft owner: /orgs/devsforge/teams/community @community --- +[draft]: https://img.shields.io/badge/document_status-draft-orange +[final]: https://img.shields.io/badge/document_status-final-blue + # Code of Conduct -![doc_status:draft](https://img.shields.io/badge/document_status-draft-red) +![document status][draft]
Document Changelog -| Ver. | Date | Author | Change description | -|------|------------|------------------|--------------------| -| 0.9 | 2025-01-19 | Serhii Horodilov | Final draft | -| 0.1 | 2025-01-10 | Serhii Horodilov | Initial draft | +| ver. | Date | Author | Change description | +|------|------------|------------------|-------------------------------| +| 0.9 | 2025-01-20 | Serhii Horodilov | Final draft | +| 0.2 | 2026-01-20 | Serhii Horodilov | Utilize community health docs | +| 0.1 | 2025-01-10 | Serhii Horodilov | Initial draft |
## Our Stance on the War in :ukraine:Ukraine -DevsForge stands with Ukraine and the Ukrainian people in the ongoing war of +OpenRoost stands with Ukraine and the Ukrainian people in the ongoing war of aggression by the Russian Federation. We condemn this illegal invasion and the humanitarian crisis it has caused. @@ -42,7 +46,7 @@ humanitarian efforts: ## Our Pledge -We, the members, contributors, and maintainers of DevsForge, pledge to make +We, the members, contributors, and maintainers of OpenRoost, pledge to make participation in our community a welcoming, respectful, and harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, @@ -59,7 +63,7 @@ transparent, and engaged community. ## Our Values -At DevsForge, our community is guided by these core values: +At OpenRoost, our community is guided by these core values: **:earth_africa: Inclusivity** We believe in creating opportunities for everyone. Our community welcomes @@ -95,15 +99,15 @@ work while remaining humble and open to improvement. ## Scope -This Code of Conduct applies to all DevsForge community spaces, including but +This Code of Conduct applies to all OpenRoost community spaces, including but not limited to: - GitHub repositories (issues, pull requests, discussions, code reviews) - Official communication channels (if applicable: Discord, Slack, mailing lists, forums) - Community events (online and in-person meetups, conferences, workshops) -- Social media interactions where you represent DevsForge -- Any other spaces where you act as a representative of the DevsForge community +- Social media interactions where you represent OpenRoost +- Any other spaces where you act as a representative of the OpenRoost community This Code of Conduct also applies when an individual is officially representing the community in public spaces. Examples of representing our community include @@ -116,7 +120,7 @@ or acting as an appointed representative at an online or offline event. - Contributors - Maintainers - Partners -- Anyone interacting with DevsForge projects and community spaces +- Anyone interacting with OpenRoost projects and community spaces This Code of Conduct applies equally to all community members, regardless of their level of contribution or standing within the community. @@ -166,7 +170,7 @@ We encourage all community members to: - Promote inclusivity and accessibility in everything you do - Respect our stance on Ukraine and human rights - Contribute to a positive, transparent community environment -- Help make DevsForge a welcoming place for everyone +- Help make OpenRoost a welcoming place for everyone ## Unacceptable Behavior @@ -216,7 +220,7 @@ in our community: **Scope of Enforcement** -- These standards apply to all community spaces and when representing DevsForge +- These standards apply to all community spaces and when representing OpenRoost - Violations may result in consequences even if they occur in public spaces outside our direct control, if they negatively impact community safety @@ -281,8 +285,6 @@ please report it as soon as possible. You can report violations by: - Contacting the community manager directly at: [todo: add email] -- Opening a confidential issue in our dedicated reporting repository (if - available) **What to Include in Your Report:** @@ -335,17 +337,19 @@ While we prefer to have contact information to follow up, you may submit anonymous reports. Please note that our ability to investigate and respond may be limited without the ability to ask follow-up questions. +--- + ## Attribution -This Code of Conduct is inspired by community best practices and open source +This Support document is inspired by community best practices and open source community standards. **License:** -This Code of Conduct is licensed under -the [Creative Commons Attribution 4.0 International License][CC-BY-4.0]. +This Support document is licensed under +[Creative Commons Attribution 4.0 International License][CC-BY-4.0]. -You are free to adapt and use this Code of Conduct for your own community, with -attribution to DevsForge. +You are free to adapt and use this document for your own community, with +attribution to OpenRoost. [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/ diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..7521cdc --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,139 @@ +--- +status: draft +owner: /orgs/devsforge/teams/maintainers @maintainers +--- + +[draft]: https://img.shields.io/badge/document_status-draft-orange +[final]: https://img.shields.io/badge/document_status-final-blue + +# Contributing Guide + +![document status][draft] + +
+Document Changelog + +| ver. | Date | Author | Change description | +|------|------------|------------------|-------------------------------| +| 0.9 | 2025-01-20 | Serhii Horodilov | Final draft | +| 0.2 | 2026-01-20 | Serhii Horodilov | Utilize community health docs | +| 0.1 | 2026-01-20 | Serhii Horodilov | Initial draft | + +
+ +## Welcome + +Thank you for your interest in contributing to OpenRoost! We welcome +contributions from everyone and appreciate your help in making our community +and software better. + +As a Ukrainian-based organization, we are committed to fostering growth and +showcasing talent within the Ukrainian tech community, while remaining open and +inclusive to contributors from all over the world. + +We communicate in both English and Ukrainian. Feel free to use either language +for your contributions, issues, and discussions. + +## Code of Conduct + +By participating in this project, you agree to abide by our +[Code of Conduct](CODE_OF_CONDUCT.md). Please read it to understand our values +and expectations for behavior within our community. + +## How Can I Contribute? + +### Reporting Bugs + +If you find a bug, please report it by opening an issue in the relevant +repository. Before reporting, please: + +- Search existing issues to see if the bug has already been reported. +- Use a clear and descriptive title. +- Follow the provided issue template, including steps to reproduce, expected + behavior, and actual behavior. + +### Suggesting Enhancements + +We welcome ideas for new features or improvements. To suggest an enhancement: + +- Check if the idea has already been proposed in issues or discussions. +- Open a new issue using the "Feature Request" template. +- Explain why this enhancement would be useful and how it should work. + +### Your First Code Contribution + +Not sure where to start? Look for issues labeled `good first issue` or +`help wanted`. These are specifically chosen for newcomers to the project. + +### Pull Requests + +To contribute code or documentation changes: + +1. **Fork** the repository and create your branch from `main`. +2. **Setup** your development environment according to the project's README. +3. **Commit** your changes using descriptive commit messages + (see Style Guides). +4. **Push** to your fork and submit a **Pull Request**. +5. **Wait** for a maintainer to review your PR. We may suggest changes or + improvements. + +All Pull Requests must include an acknowledgment of our Code of Conduct. + +## Development Process + +We follow a transparent development process. All work is tracked via GitHub +Issues and Project boards. + +- **Main Branch**: The `main` branch is the primary branch for development. +- **Code Reviews**: All PRs require at least one approval from a maintainer + before merging. +- **Testing**: Ensure that your changes do not break existing functionality. + Add new tests where appropriate. + +## Style Guides + +### Git Commit Messages + +- Use the present tense ("Add feature" not "Added feature"). +- Use the imperative mood ("Fix bug" not "Fixes bug"). +- Keep the subject line short (under 50 characters). +- Provide more detail in the body if necessary. + +### Documentation Style + +- Use clear, concise language. +- Follow Markdown best practices. +- For organization-wide documentation, we prefer a professional yet welcoming + tone. +- Where appropriate, use bilingual labels for clarity (e.g., ":gb: English / + :ukraine: Українська"). + +## Community + +Join our community to discuss projects, seek help, or share your growth +journey: + +- [GitHub Discussions](https://github.com/orgs/devsforge/discussions) +- [Support Guide](SUPPORT.md) + +## Recognition + +We value and recognize all contributions. Contributors will be credited in the +repository's README or a dedicated CONTRIBUTORS file. + +--- + +## Attribution + +This Support document is inspired by community best practices and open source +community standards. + +**License:** + +This Support document is licensed under +[Creative Commons Attribution 4.0 International License][CC-BY-4.0]. + +You are free to adapt and use this document for your own community, with +attribution to OpenRoost. + +[CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/ diff --git a/docs/SECURITY.md b/docs/SECURITY.md index 0605c5a..623dacf 100644 --- a/docs/SECURITY.md +++ b/docs/SECURITY.md @@ -3,18 +3,22 @@ status: draft owner: /orgs/devsforge/teams/security @security --- +[draft]: https://img.shields.io/badge/document_status-draft-orange +[final]: https://img.shields.io/badge/document_status-final-blue + # Security Policy -![status: draft](https://img.shields.io/badge/status-draft-red) +![document status][draft]
Document Changelog -| Ver. | Date | Author | Change description | -|------|------------|------------------|----------------------------| -| 0.9 | 2025-01-20 | Serhii Horodilov | Final draft | -| 0.2 | 2025-01-19 | Serhii Horodilov | Update Attribution section | -| 0.1 | 2025-01-19 | Serhii Horodilov | Initial draft | +| ver. | Date | Author | Change description | +|------|------------|------------------|-------------------------------| +| 0.9 | 2025-01-20 | Serhii Horodilov | Final draft | +| 0.3 | 2026-01-20 | Serhii Horodilov | Utilize community health docs | +| 0.2 | 2025-01-19 | Serhii Horodilov | Update Attribution section | +| 0.1 | 2025-01-19 | Serhii Horodilov | Initial draft |
@@ -82,12 +86,12 @@ discovery (unless you prefer to remain anonymous). ## Scope -This security policy applies to all repositories within the DevsForge +This security policy applies to all repositories within the OpenRoost organization, including both public and private repositories. ### In Scope -- Security vulnerabilities in DevsForge-maintained code +- Security vulnerabilities in OpenRoost-maintained code - Configuration issues that could lead to security exposure - Authentication and authorization flaws - Data exposure risks @@ -130,17 +134,19 @@ introduce: Security reports and incidents are handled by our dedicated security team. For general security inquiries, please use the channels listed above. +--- + ## Attribution -This Security Policy is inspired by community best practices and open source -security standards. +This Support document is inspired by community best practices and open source +community standards. **License:** -This Security Policy is licensed under -the [Creative Commons Attribution 4.0 International License][CC-BY-4.0]. +This Support document is licensed under +[Creative Commons Attribution 4.0 International License][CC-BY-4.0]. -You are free to adapt and use this Security Policy for your own community, with -attribution to DevsForge. +You are free to adapt and use this document for your own community, with +attribution to OpenRoost. [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/ diff --git a/docs/SUPPORT.md b/docs/SUPPORT.md index aaf893b..15caa95 100644 --- a/docs/SUPPORT.md +++ b/docs/SUPPORT.md @@ -3,17 +3,21 @@ status: draft owner: /orgs/devsforge/teams/support @support --- +[draft]: https://img.shields.io/badge/document_status-draft-orange +[final]: https://img.shields.io/badge/document_status-final-blue + # Support -![status: draft](https://img.shields.io/badge/status-draft-red) +![document status][draft] -| Ver. | Date | Author | Change description | -|------|------------|------------------|----------------------------| -| 0.9 | 2025-01-20 | Serhii Horodilov | Final draft | -| 0.2 | 2025-01-19 | Serhii Horodilov | Update Attribution section | -| 0.1 | 2025-01-19 | Serhii Horodilov | Initial draft | +| ver. | Date | Author | Change description | +|------|------------|------------------|-------------------------------| +| 0.9 | 2025-01-20 | Serhii Horodilov | Final draft | +| 0.3 | 2026-01-20 | Serhii Horodilov | Utilize community health docs | +| 0.2 | 2025-01-19 | Serhii Horodilov | Update Attribution section | +| 0.1 | 2025-01-19 | Serhii Horodilov | Initial draft | -Welcome to DevsForge! This document outlines how to get help, ask questions, +Welcome to OpenRoost! This document outlines how to get help, ask questions, and connect with our community. We communicate in both English and Ukrainian. @@ -31,7 +35,7 @@ For general questions, ideas, and community conversations, please use This is our primary support channel and the best place to: -- Ask questions about DevsForge projects +- Ask questions about OpenRoost projects - Share ideas and suggestions - Connect with other community members - Seek guidance on developer growth and learning @@ -60,7 +64,7 @@ Instead, follow the process outlined in our [Security Policy](SECURITY.md). ### Technical Support -For technical questions related to DevsForge projects, tools, and +For technical questions related to OpenRoost projects, tools, and implementations, our support team is here to help. Responsible team: @support @@ -77,8 +81,8 @@ Responsible team: @community While we want to be as helpful as possible, some topics fall outside our support scope: -- Support for third-party tools or services not maintained by DevsForge -- General programming questions unrelated to DevsForge projects +- Support for third-party tools or services not maintained by OpenRoost +- General programming questions unrelated to OpenRoost projects - Requests that violate our [Code of Conduct](CODE_OF_CONDUCT.md) ## Resources @@ -87,6 +91,8 @@ support scope: _Coming soon._ +--- + ## Attribution This Support document is inspired by community best practices and open source @@ -95,9 +101,9 @@ community standards. **License:** This Support document is licensed under -the [Creative Commons Attribution 4.0 International License][CC-BY-4.0]. +[Creative Commons Attribution 4.0 International License][CC-BY-4.0]. You are free to adapt and use this document for your own community, with -attribution to DevsForge. +attribution to OpenRoost. [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/