Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (40 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

50 lines (40 loc) · 1.61 KB

Contributing Guidelines

Thank you for your interest in contributing to the College Assignment Help Platform!
We welcome all contributions — from new features and documentation improvements to bug fixes.

📋 Prerequisites

Before contributing, please ensure that you have:

  • Node.js (v18 or later)
  • npm or yarn
  • A Supabase account with an existing project (for testing)
  • Git installed and configured

🧩 How to Contribute

1. Fork the Repository

Click the Fork button at the top-right corner of this repository to create your copy.

2. Clone Your Fork

git clone https://github.com/your-username/college-assignment-platform.git
cd college-assignment-platform

3. Create a New Branch

Create a new branch for your feature or fix:

Contribution Workflow

  • Pick an Issue
  • You can self-assign issues if no one else is working on them.
  • Multiple contributors can collaborate on larger features — mention in the issue comments if you’re teaming up.
  • Discuss Before Coding
  • Comment your implementation plan or questions in the issue thread before starting.
  • This ensures consistency and avoids duplicate work.
  • Make Your Changes
  • Follow the coding style of the repository.
  • Keep commits small and descriptive

Pull Request Guidelines

  • When you open a Pull Request (PR):
  • Use a clear title describing your change (e.g., fix: auth redirect issue or feat: add Supabase file upload).
  • In the PR description, include:
  • Linked issue number (e.g., “Closes #12”)
  • Before & After screenshots or code snippets that show your change
  • Short explanation of what and why you changed