Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (50 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

76 lines (50 loc) · 2.23 KB

Contributing Guidelines

Thank you for your interest in contributing to this project! We welcome first-time contributors and value clear communication, clean code, and respectful collaboration.

This repository is part of the ChronalLabs open-source organization.

How to Contribute

  1. Fork the repository to your GitHub account.
  2. Create a new branch for your feature or bug fix.
  3. Make small, meaningful, and well-documented commits.
  4. Submit a pull request (PR) with a clear title and description explaining your changes.

All contributions must go through the pull request process.
Direct pushes to the main branch are not allowed.

Important: Permission & Communication

To keep the project focused and well-organized, please follow these rules:

  • If you want to start working on any existing issue, feature, or task,
    please contact the project admin first for confirmation.

  • If you want to contribute to any repository under ChronalLabs,
    you must first take approval from the admin.

  • If you have a new project idea, please note:

    • New projects must align with the official project ideas list
    • Unlisted or unrelated projects will not be accepted
    • Discuss the idea with the admin before starting any work

📧 Admin Contact Email:
chawlamanan26@gmail.com

Code Style and Quality

  • Follow clean, readable, and maintainable coding practices.
  • Write clear variable and function names.
  • Add comments where necessary to explain non-obvious logic.
  • Keep changes minimal and relevant to the issue being solved.

Reporting Issues

  • Use GitHub Issues to report bugs or suggest improvements.
  • Clearly describe:
    • What the issue is
    • Steps to reproduce (if applicable)
    • Expected behavior

Please check existing issues before opening a new one.

Community Guidelines

  • Be respectful, supportive, and constructive in all discussions.
  • This is a beginner-friendly project, so patience and clarity are appreciated.
  • Feedback is part of the learning process—be open to suggestions and reviews.

Final Notes

All contributions are reviewed by the project maintainers. Following these guidelines helps ensure a smooth and productive collaboration for everyone involved.