Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (45 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

68 lines (45 loc) · 2.26 KB
Raw

Contributing

Template note: replace every ALL_CAPS placeholder in this file before publishing or sharing the repository.

Thank you for your interest in contributing to PROJECT_NAME. This guide covers questions, bug reports, feature requests, and pull requests. For private vulnerability reporting, use SECURITY.md instead of public channels.

Asking Questions

Use REPLACE_ME_SUPPORT_CHANNEL for usage questions, troubleshooting, and general discussion. If the project uses multiple support channels, document which kinds of questions belong in each one.

Reporting Bugs

Report non-security bugs through REPLACE_ME_BUG_REPORT_CHANNEL. Include the following details when possible:

  • version, commit, or environment details
  • steps to reproduce
  • expected behavior
  • actual behavior
  • logs, screenshots, or a minimal reproduction

If you are reporting a security issue, stop and follow SECURITY.md instead.

Proposing Features

Use REPLACE_ME_FEATURE_REQUEST_CHANNEL for feature requests and design proposals. For larger changes, describe the problem, the proposed approach, and any compatibility or migration concerns before starting implementation.

Pull Requests

Unless the repository documents a different process, contributors should:

  1. Keep changes focused and scoped to a single problem.
  2. Add or update tests when behavior changes.
  3. Update documentation when user-facing behavior changes.
  4. Describe the change clearly in the pull request.
  5. Make sure CI passes before requesting review.

Replace this section with any repository-specific expectations such as branch naming, commit conventions, changelog entries, or release notes requirements.

Local Setup

Replace this section with the actual setup steps for the repository.

REPLACE_ME_SETUP_COMMAND

Useful project commands:

REPLACE_ME_TEST_COMMAND
REPLACE_ME_LINT_COMMAND
REPLACE_ME_FORMAT_COMMAND

Code of Conduct

Replace this section with the actual Code of Conduct path or URL. Example: REPLACE_ME_CODE_OF_CONDUCT_PATH_OR_URL

License and Ownership

State any contribution licensing terms only if the project actually requires them. If the repository uses a CLA, DCO, or other contribution agreement, replace this section with the real policy.