Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (39 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

53 lines (39 loc) · 1.72 KB

Contributing to This Project

Thank you for your interest in contributing! We welcome pull requests and contributions from the community. Please take a moment to read the guidelines below to ensure a smooth collaboration process.

📦 Getting Started

  1. Fork the Repository
    Click the Fork button at the top of the repository page to create your own copy of the project.

  2. Clone Your Fork

    git clone https://github.com/your-username/your-fork.git
cd your-fork

  3. Create a Feature Branch Create a new branch based on main for your changes:

git checkout -b feature/your-feature-name

🚀 Submitting a Pull Request

Once you’re ready to share your changes: 1. Ensure Code Quality • Run all linting checks. • Use Prettier to format your code. • Confirm all tests pass (if applicable). 2. Document Your Work • Add meaningful comments to your code. • Update or add documentation where necessary (e.g., README, inline comments, or docs folder). 3. Submit Your PR • Push your branch to your fork:

git push origin feature/your-feature-name
  • Open a Pull Request against the main branch of the original repository.
  • Include a clear summary of your changes and why they are beneficial.

✅ Code Standards * Follow the existing code style and formatting conventions.

  • All code must pass linting and Prettier formatting before submission.
  • Keep your changes focused and limited to the scope of your feature or fix.

❤️ Be Kind

  • Be respectful and constructive in code reviews and discussions.
  • Ask questions if you’re unsure—collaboration is key.

We appreciate your help in improving the project for everyone. Thank you for contributing!