Skip to content

Latest commit

 

History

History
70 lines (46 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

70 lines (46 loc) · 2.68 KB

Contributing to Miffan

Thank you for your interest in contributing to RikkaHub. To keep reviews focused and the project maintainable, please read the following rules before opening a pull request.

Contribution policy

Every pull request must be linked to an issue

Open an issue before starting work. Every pull request must reference at least one related issue in its description, for example with Fixes #123 or Related to #123.

Pull requests without a corresponding issue will not be accepted.

No new-feature pull requests

We do not accept pull requests that add new features. RikkaHub is an opinionated project, and new features need to be designed and implemented by the maintainers to keep the product direction and user experience consistent.

You may still submit a feature request as an issue for discussion, but please do not send an implementation pull request.

No large pull requests

We do not accept large pull requests, including broad refactors, sweeping architectural changes, or changes that combine several unrelated concerns. Keep each pull request small, focused, and easy to review.

If a fix requires extensive changes, discuss it in the related issue first. The maintainers may ask you to reduce the scope or split the work into multiple independent pull requests.

Issue standards

Please read the Issue guidelines before opening an issue. Use the closest form, search for duplicates first, keep one topic per issue, and include enough version, environment, and reproduction information for the maintainer to verify it. Never post API keys, tokens, cookies, private conversations, or unsanitized logs.

The available forms are:

  • Bug Report for reproducible failures, crashes, and regressions
  • Feature Request for a proposed product improvement
  • Configuration & Support for setup and usage questions

Blank issues are disabled. Issues may be closed or redirected when they lack the information needed for triage, duplicate an existing report, or fall outside the project's scope.

What we accept

In general, acceptable contributions include:

  • Small, focused bug fixes for an existing issue
  • Small documentation corrections
  • Small maintenance changes that preserve existing behavior

Translation-related pull requests are not accepted.

Before submitting

Please make sure that your pull request:

  • Links to at least one issue
  • Contains one focused change and is not a large-scale modification
  • Does not add a new feature
  • Explains what changed and how it was verified
  • Follows the existing code style
  • Builds successfully and does not introduce unrelated changes

Pull requests that do not follow these guidelines may be closed without review.