Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
110 lines (88 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

110 lines (88 loc) · 3.03 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to the College Club Website

This project is maintained by the ALGON DC Technical team and is intended for collaborative academic development. To keep the codebase clean, stable, and easy to manage, please follow the guidelines below.

📌 General Rules

  • Do NOT push directly to the main branch
  • All work must be done on a feature branch
  • Always discuss changes with the team before starting major work
  • Keep commits clean, meaningful, and well-documented
  • Respect deadlines and academic integrity

🌱 Branching Strategy

Main Branch

  • main is the stable production branch
  • Only reviewed and approved code will be merged into main

Feature Branches

  • Create a new branch for every feature or fix
  • Branch naming convention: feature/ fix/ docs/ Examples:
  • feature/events-page
  • feature/login-system
  • fix/navbar-alignment
  • docs/contributing-guidelines

🛠️ How to Contribute

Step 1: Sync with Main

git checkout main
git pull origin main

Step 2: Create a Feature Branch

git checkout -b feature/your-feature-name

Step 3: Make Changes

  • Write clean and readable code
  • Follow existing project structure
  • Comment where necessary

Step 4: Commit Changes

git add .
git commit -m "Add: brief description of changes"

Commit message guidelines:

  • Use present tense (Add, Fix, Update)
  • Be short but descriptive Examples:
  • Add: event registration form
  • Fix: navbar responsive layout
  • Update: homepage hero section

🔀 Pull Request Process

1. Push your feature branch to GitHub

git push origin feature/your-feature-name

2. Create a Pull Request

  • Go to the repository on GitHub
  • Click on "Pull Requests" → "New Pull Request"
  • Select your feature branch as the source
  • Add a clear title and description of your changes
  • Request reviews from team members

3. Code Review

  • Wait for at least one approval from a team member
  • Address any requested changes
  • Keep discussions respectful and constructive

4. Merge

  • Once approved, a maintainer will merge your PR into main
  • Delete your feature branch after merging

✅ Code Quality Standards

  • Write clean, readable code with proper indentation
  • Use meaningful variable and function names
  • Comment complex logic for better understanding
  • Test your changes before pushing
  • Avoid committing unnecessary files (e.g., node_modules/, .env, IDE configs)

🚫 What NOT to Do

  • ❌ Don't push directly to main
  • ❌ Don't commit large binary files
  • ❌ Don't include sensitive information (API keys, passwords)
  • ❌ Don't merge your own PRs without review
  • ❌ Don't work on someone else's branch without permission

📞 Communication

  • Discuss major changes in team meetings or group chat
  • Tag relevant team members in PR discussions
  • Ask for help when stuck—collaboration is key!



Let's make this website and create an Impact✨✨