Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (39 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

60 lines (39 loc) · 1.71 KB

Contributing Guidelines

Thank you for your interest in contributing to this organization. We welcome contributions that align with our goals and standards.

Please read this document carefully before starting any work.

📌 Before You Start

  • Familiarize yourself with the organization’s goals and active projects
  • Review any repository-specific documentation
  • Ensure your contribution aligns with the project scope

⚠️ Important:
Changes to organization-wide repositories (such as .github) require explicit approval from the organization owner before any work begins.

🛠 Contribution Process

  1. Open an Issue

    • Clearly describe the problem, proposal, or improvement
    • Wait for confirmation or guidance before starting work

  2. Create a Branch

    • Use a descriptive name (e.g., feature/add-validation, fix/api-error)
    • Do not work directly on the main branch

  3. Make Your Changes

    • Follow coding standards and best practices
    • Keep commits small and meaningful

  4. Open a Pull Request

    • Reference the related issue
    • Clearly explain what was changed and why
    • Complete the PR checklist if provided

  5. Review & Approval

    • Address feedback promptly
    • Merges require approval from maintainers or owners

✅ Best Practices

  • Write clear commit messages
  • Avoid unrelated changes in a single PR
  • Be respectful and collaborative in discussions
  • Ask questions if requirements are unclear

📄 License & Attribution

By contributing, you agree that your contributions may be used, modified, and distributed under the same license as the project.

We appreciate your time and effort in helping improve this organization’s work.