Skip to content
Open
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
132 changes: 132 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
---
status: draft
owner: /orgs/devsforge/teams/maintainers @maintainers
---

# Contributing Guide

![status: draft](https://img.shields.io/badge/status-draft-red)

<details>
<summary>Document Changelog</summary>

| Ver. | Date | Author | Change description |
|------|------------|------------------|--------------------|
| 0.1 | 2026-01-20 | Serhii Horodilov | Initial draft |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Restore finalized contributing-guide history

When this PR is compared with the target docs/community-health branch, this changelog is stale: the target branch already has the contributing guide finalized with later history entries for 0.9 (“Final draft”) and 0.2 (“Utilize community health docs”). Keeping only the initial 0.1 entry would regress the published document metadata/history for anyone reviewing or resolving the branch against docs/community-health.

Useful? React with 👍 / 👎.


</details>

## 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 Contributing Guide is inspired by community best practices and open source
community standards.

**License:**

This Contributing Guide is licensed under the [Creative Commons Attribution 4.0
International License][CC-BY-4.0].

You are free to adapt and use this guide for your own community, with
attribution to OpenRoost.

[CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/