Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (65 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

99 lines (65 loc) · 2.43 KB

Contributing to README Design Kit

Thank you for your interest in contributing README Design Kit. Please follow the workflow below to ensure smooth collaboration and faster review.

Contribution Workflow

I. Steps to Contribute

  1. Fork the repository - Click the Fork button to create your own copy of this repository.

  2. Clone your fork

    git clone https://github.com/<your-username>/<repository>.git

  3. Create a new branch

    git checkout -b <issue-number>-<short-description>

  4. Make your changes

  5. Commit your changes

    git add .
git commit -m "Fix: <short description>"

  6. Push the branch

    git push origin <branch-name>

  7. Create a Pull Request (PR)

    • A PR must only be created for an assigned issue
    • Each PR must address only one issue
    • Follow the repository structure and guidelines

Important Rules

  • No PR should be created without an assigned issue.
  • One issue → one PR.
  • If you are participating in the Open Source Program, make sure to open only one issue at a time.
  • Follow the repository’s existing structure and coding style.

II. Issue Difficulty & Timelines

Issues will be labeled based on difficulty. The expected timeline for completion is as follows:

Easy / Beginner (easy label)

  • Issue resolution: within 3 days
  • PR submission: within 3 days
  • Extension allowed only for valid reasons and with maintainer approval

Medium / Intermediate (medium label)

  • Issue resolution: within 7 days
  • PR submission: within 10 days (7 days + 3 additional days)

Hard / Advanced (hard label)

  • Issue resolution: within 10 days
  • PR submission: within 15 days (10 days + 5 additional days)

III. Abandonment Policy

If an issue or PR is abandoned more than two times, the contributor may be temporarily or permanently restricted from contributing to the project.

Abandonment includes:

  • No updates for an extended period
  • No response to maintainer comments
  • Missed deadlines without communication

IV. Zero-Tolerance Policies

The following will be closed immediately without review:

  • Spam issues or PRs
  • Low-effort, copy-paste, or AI-generated PRs
  • Duplicate issues without justification
  • PRs without a linked and assigned issue

~ Thank you for contributing your time, skills, and creativity. Together, let's build something amazing!

Happy Contributing!!