|
| 1 | +--- |
| 2 | +status: draft |
| 3 | +owner: /orgs/devsforge/teams/maintainers @maintainers |
| 4 | +--- |
| 5 | + |
1 | 6 | # Contributing Guide |
| 7 | + |
| 8 | + |
| 9 | + |
| 10 | +<details> |
| 11 | +<summary>Document Changelog</summary> |
| 12 | + |
| 13 | +| Ver. | Date | Author | Change description | |
| 14 | +|------|------------|------------------|--------------------| |
| 15 | +| 0.1 | 2026-01-20 | Serhii Horodilov | Initial draft | |
| 16 | + |
| 17 | +</details> |
| 18 | + |
| 19 | +## Welcome |
| 20 | + |
| 21 | +Thank you for your interest in contributing to OpenRoost! We welcome |
| 22 | +contributions from everyone and appreciate your help in making our community |
| 23 | +and software better. |
| 24 | + |
| 25 | +As a Ukrainian-based organization, we are committed to fostering growth and |
| 26 | +showcasing talent within the Ukrainian tech community, while remaining open and |
| 27 | +inclusive to contributors from all over the world. |
| 28 | + |
| 29 | +We communicate in both English and Ukrainian. Feel free to use either language |
| 30 | +for your contributions, issues, and discussions. |
| 31 | + |
| 32 | +## Code of Conduct |
| 33 | + |
| 34 | +By participating in this project, you agree to abide by our |
| 35 | +[Code of Conduct](CODE_OF_CONDUCT.md). Please read it to understand our values |
| 36 | +and expectations for behavior within our community. |
| 37 | + |
| 38 | +## How Can I Contribute? |
| 39 | + |
| 40 | +### Reporting Bugs |
| 41 | + |
| 42 | +If you find a bug, please report it by opening an issue in the relevant |
| 43 | +repository. Before reporting, please: |
| 44 | + |
| 45 | +- Search existing issues to see if the bug has already been reported. |
| 46 | +- Use a clear and descriptive title. |
| 47 | +- Follow the provided issue template, including steps to reproduce, expected |
| 48 | + behavior, and actual behavior. |
| 49 | + |
| 50 | +### Suggesting Enhancements |
| 51 | + |
| 52 | +We welcome ideas for new features or improvements. To suggest an enhancement: |
| 53 | + |
| 54 | +- Check if the idea has already been proposed in issues or discussions. |
| 55 | +- Open a new issue using the "Feature Request" template. |
| 56 | +- Explain why this enhancement would be useful and how it should work. |
| 57 | + |
| 58 | +### Your First Code Contribution |
| 59 | + |
| 60 | +Not sure where to start? Look for issues labeled `good first issue` or |
| 61 | +`help wanted`. These are specifically chosen for newcomers to the project. |
| 62 | + |
| 63 | +### Pull Requests |
| 64 | + |
| 65 | +To contribute code or documentation changes: |
| 66 | + |
| 67 | +1. **Fork** the repository and create your branch from `main`. |
| 68 | +2. **Setup** your development environment according to the project's README. |
| 69 | +3. **Commit** your changes using descriptive commit messages |
| 70 | + (see Style Guides). |
| 71 | +4. **Push** to your fork and submit a **Pull Request**. |
| 72 | +5. **Wait** for a maintainer to review your PR. We may suggest changes or |
| 73 | + improvements. |
| 74 | + |
| 75 | +All Pull Requests must include an acknowledgment of our Code of Conduct. |
| 76 | + |
| 77 | +## Development Process |
| 78 | + |
| 79 | +We follow a transparent development process. All work is tracked via GitHub |
| 80 | +Issues and Project boards. |
| 81 | + |
| 82 | +- **Main Branch**: The `main` branch is the primary branch for development. |
| 83 | +- **Code Reviews**: All PRs require at least one approval from a maintainer |
| 84 | + before merging. |
| 85 | +- **Testing**: Ensure that your changes do not break existing functionality. |
| 86 | + Add new tests where appropriate. |
| 87 | + |
| 88 | +## Style Guides |
| 89 | + |
| 90 | +### Git Commit Messages |
| 91 | + |
| 92 | +- Use the present tense ("Add feature" not "Added feature"). |
| 93 | +- Use the imperative mood ("Fix bug" not "Fixes bug"). |
| 94 | +- Keep the subject line short (under 50 characters). |
| 95 | +- Provide more detail in the body if necessary. |
| 96 | + |
| 97 | +### Documentation Style |
| 98 | + |
| 99 | +- Use clear, concise language. |
| 100 | +- Follow Markdown best practices. |
| 101 | +- For organization-wide documentation, we prefer a professional yet welcoming |
| 102 | + tone. |
| 103 | +- Where appropriate, use bilingual labels for clarity (e.g., ":gb: English / |
| 104 | + :ukraine: Українська"). |
| 105 | + |
| 106 | +## Community |
| 107 | + |
| 108 | +Join our community to discuss projects, seek help, or share your growth |
| 109 | +journey: |
| 110 | + |
| 111 | +- [GitHub Discussions](https://github.com/orgs/devsforge/discussions) |
| 112 | +- [Support Guide](SUPPORT.md) |
| 113 | + |
| 114 | +## Recognition |
| 115 | + |
| 116 | +We value and recognize all contributions. Contributors will be credited in the |
| 117 | +repository's README or a dedicated CONTRIBUTORS file. |
| 118 | + |
| 119 | +## Attribution |
| 120 | + |
| 121 | +This Contributing Guide is inspired by community best practices and open source |
| 122 | +community standards. |
| 123 | + |
| 124 | +**License:** |
| 125 | + |
| 126 | +This Contributing Guide is licensed under the [Creative Commons Attribution 4.0 |
| 127 | +International License][CC-BY-4.0]. |
| 128 | + |
| 129 | +You are free to adapt and use this guide for your own community, with |
| 130 | +attribution to OpenRoost. |
| 131 | + |
| 132 | +[CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/ |
0 commit comments