Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (30 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 1.59 KB

Contributing to Oremif Projects

Thanks for your interest in contributing to Oremif.

This repository provides default contribution guidelines for Oremif projects. If a repository has its own CONTRIBUTING.md, that repository-specific guidance takes precedence over this file.

Before opening an issue

  • Read the repository README and project documentation first.
  • Search existing issues to avoid duplicates.
  • Use reactions on existing issues to show interest instead of posting +1.

Bug reports

When reporting a bug, include:

  • the affected package version or commit SHA;
  • Kotlin version and target platform;
  • a minimal reproducer;
  • expected behavior and actual behavior;
  • stack traces, logs, or screenshots when relevant.

Feature requests

  • Start with the problem or use case, not only the proposed solution.
  • For public API changes or large features, open an issue before writing code.
  • If the change is mathematically or algorithmically significant, include a reference.

Pull requests

  • Target the repository's default branch unless the repository says otherwise.
  • Keep pull requests focused. Avoid mixing unrelated refactors with functional changes.
  • Add or update tests for behavior changes and bug fixes.
  • Update documentation, examples, or KDoc when public behavior changes.
  • Follow the existing code style and repository conventions.
  • Avoid adding new dependencies without a clear justification.

Review and maintenance

Oremif repositories are maintained on a best-effort basis by a solo maintainer. Review and merge times may vary depending on scope and maintenance load.