Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
109 lines (74 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

109 lines (74 loc) · 2.74 KB

Contributing to moizy-open-source-issues 🚀

Thank you for your interest in contributing! This guide will help you understand how to participate, submit issues, and create pull requests in a professional and organized way.

Table of Contents

  1. How to Contribute
  2. Branching Guidelines
  3. Issue Guidelines
  4. Pull Request Guidelines
  5. Code Style
  6. Community Guidelines
  7. Getting Help

How to Contribute

  1. Find an Issue
    Go to the Issues tab and pick an open issue that interests you.

  2. Claim the Issue

    Comment on the issue:

    I would like to work on this issue.
  • Wait for confirmation before starting.

  1. Fork the Repository
    Click Fork in the top-right corner of the repo.

  2. Create a Branch
    Always work on a separate branch for each issue:

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

  3. Make Changes and Commit

  • Write clean, readable, and well-commented code.
  • Commit with a clear message: 
    git commit -m "fix: add email validation function"
  1. Push and Create PR 
    git push origin issue-<issue-number>-short-description

Open a Pull Request referencing the issue.

Branching Guidelines

  • main → Always stable, production-ready code.
  • issue--short-description → Each issue gets a separate branch.
  • Avoid committing directly to main.

Issue Guidelines

  • Only pick one issue at a time.
  • Solve the issue within 7 days of assignment.
  • Add proper examples or tests if needed.
  • Respect existing code style and project structure.

Pull Request Guidelines

  • Reference the issue number in PR description: 
    Closes #<issue-number>
  • Provide a clear description of what the PR does.
  • Ensure the PR passes all tests (if any).
  • Avoid unrelated changes in the PR.
  • Wait for review and respond politely to feedback.

Code Style

  • Follow consistent indentation and formatting.
  • Use descriptive variable and function names.
  • Comment complex logic for clarity.
  • Avoid unnecessary code duplication.

Community Guidelines

  • Be respectful, polite, and professional.
  • No spam, trolling, or offensive language.
  • Encourage learning and collaboration.
  • Respect others’ contributions and opinions.

Getting Help

  • If you have questions or need guidance:
  • Open a discussion in the Discussions tab.
  • Reach out via GitHub issues with [Help Wanted] label.
  • Thank you for contributing! Your efforts help make this project better and support the learning community. 🚀