Skip to content
Merged
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
56 changes: 56 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Contributing to OwlPlug

Thank you for your interest in contributing to OwlPlug — your help improves the product for everyone.

This document explains how to report issues and propose changes, how to prepare and submit pull requests, and the legal requirement for contributions (CLA). For general project information and the development setup refer to the main project README: [README.md](https://github.com/DropSnorz/OwlPlug/blob/master/README.md).

## Quick start

- Read the README: [README.md](https://github.com/DropSnorz/OwlPlug/blob/master/README.md)
- Review the Contributor License Agreement: [CLA.md](https://github.com/DropSnorz/OwlPlug/blob/master/CLA.md) — by submitting a contribution you are agreeing to that CLA.

## Contributor License Agreement (CLA)

All contributors must agree to the project CLA. The CLA assigns copyright in contributions to the project maintainer while granting you a license back to use your contribution. The full text is in [CLA.md](https://github.com/DropSnorz/OwlPlug/blob/master/CLA.md).

By submitting a pull request, issue, or other contribution you confirm that you have read and agree to the CLA.

## Reporting issues and feature requests

Before opening a new issue:
- Search existing issues to avoid duplicates.
- When creating an issue, use a clear title and include:
- A short description of the problem or requested feature.
- Steps to reproduce (for bugs).
- Expected vs actual behavior.
- Operating system and OwlPlug version.
- Any relevant logs or stack traces.

Helpful links:
- Issues: https://github.com/DropSnorz/OwlPlug/issues
- Documentation & troubleshooting: https://github.com/DropSnorz/OwlPlug/wiki

## Code contributions (pull requests)

**Important** - Before submitting code changes, please ensure there is an existing issue for the change, or open a new one to discuss it first. This helps confirm the idea aligns with the project’s direction.

General workflow
1. Fork the repository.
2. Create a branch for your change:
- feat/my-short-description
- fix/issue-123-short-desc
- docs/update-docs
3. Make your changes in the fork and commit.
4. Run tests and verify build locally.
5. Open a pull request (PR) from your branch to default (`master`).

What to include in your PR
- A clear title and description of what you changed and why.
- Link to original issue
- Any steps required to test the change.
- Screenshots for UI changes.
- If applicable, add or update tests to cover the change.

Review process
- Maintainers and reviewers may request changes. Please respond to feedback and update your PR as needed.
- Once approved, a maintainer will merge the PR.
Loading