Skip to content

Latest commit

 

History

History
63 lines (44 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

63 lines (44 loc) · 2.88 KB

Contributing to Cyrus

Cyrus is an open source project licensed under the GPL license.
Every contribution is welcome and appreciated, regardless of its scale or importance.

What Counts as a Contribution?

Contributions include documentation, code, packaging, answering issues, fixing bugs, and more.

Before Filing an Issue

Please check if a similar issue already exists to avoid repetitive questions.

Filing an Issue

When you encounter a problem or have a suggestion for improvement, please follow these guidelines to help us understand and address your issue effectively:

  1. Provide a Clear Title
    Use a concise and descriptive title for your issue to help others quickly grasp the problem.

  2. Describe the Problem
    In the issue body, provide a detailed description including:

    • Expected Behavior: What you expected to happen.
    • Actual Behavior: What actually happened.
    • Steps to Reproduce: A clear, step-by-step list to reproduce the issue.
    • Environment Details: Include relevant information such as:
      • Operating System (e.g., Windows, macOS, Linux)
      • Software version
      • Relevant dependencies or configurations

  3. Include Screenshots or Logs
    If applicable, attach screenshots or logs that help illustrate the issue and provide additional context.

  4. Label Your Issue
    If you have permission, please add appropriate labels (e.g., bug, enhancement, question) to help maintainers prioritize and organize issues.

  5. Be Respectful and Patient
    Remember that contributors are often volunteers. Please communicate respectfully and be patient while waiting for a response.

Submitting a Draft PR

We encourage submitting draft pull requests (PRs) to start discussions and get early feedback. To submit a draft PR:

  1. Create a new branch from the latest main branch for your changes.
  2. Make your changes and commit them with clear, descriptive messages.
  3. Push your branch to your forked repository.
  4. Open a pull request on this repository:
    • Select “Create draft pull request” to indicate your work is in progress.
    • Provide a clear description of the problem you’re addressing and your approach.
    • Include any relevant screenshots, logs, or context to help reviewers.
  5. Use the draft PR to discuss and iterate with maintainers until it is ready to be marked as “ready for review.”

Draft PRs help us collaborate early and often, so don’t hesitate to share your ideas.

Un-draft and Finalize Your PR

When your draft PR is ready for full review:

  1. Ensure all required checks (tests, CI, etc.) are passing.
  2. Update your PR description with any new information or changes.
  3. Click the “Ready for review” button to convert your draft PR into a standard PR.
  4. Address any feedback from maintainers or reviewers promptly.
  5. Once approved, your PR will be merged.