Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (49 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

76 lines (49 loc) · 1.74 KB
Raw

Contributing to PrepPilot

Thank you for your interest in contributing to PrepPilot! 🚀

We welcome contributions from developers of all experience levels. Whether you're fixing bugs, improving documentation, enhancing the UI, or adding new features, your contributions help make PrepPilot better for everyone.

Getting Started

1. Fork the Repository

Fork the repository to your GitHub account and clone it locally:

git clone https://github.com/YOUR_USERNAME/PrepPilot.git
cd PrepPilot

2. Create a New Branch

Create a descriptive branch for your work:

git checkout -b feature/your-feature-name

or

git checkout -b fix/issue-description

3. Make Your Changes

  • Follow the existing project structure.
  • Keep code clean and readable.
  • Reuse existing components whenever possible.
  • Add comments for complex logic.

4. Test Your Changes

Ensure that your changes work correctly before submitting a pull request.

5. Commit Your Changes

Use clear and meaningful commit messages:

git commit -m "docs: add contributing guidelines"

6. Submit a Pull Request

Push your branch and open a Pull Request against the main repository.

Contribution Types

  • Bug fixes
  • New features
  • Documentation improvements
  • UI/UX enhancements
  • Performance optimizations
  • Code refactoring

Pull Request Checklist

  • Code follows project conventions
  • Changes have been tested locally
  • Documentation has been updated if required
  • Commit messages are meaningful
  • PR description clearly explains the changes

Code of Conduct

Be respectful and constructive when interacting with other contributors. We aim to maintain a welcoming and inclusive community.

Happy Contributing! 🎉