How to Contribute

How to Contribute

Thank you for your interest in contributing to CoogCasa! This guide will help you get started.

Ways to Contribute

1. Report Bugs

Found a bug? Open an issue with:

• Clear title describing the bug
• Steps to reproduce
• Expected vs actual behavior
• Screenshots (if applicable)
• Browser/device information

2. Suggest Features

Have an idea? We’d love to hear it!

• Check existing issues first
• Open a new issue with the enhancement label
• Describe the feature and its use case
• Include mockups if you have them

3. Improve Documentation

Documentation is always appreciated:

• Fix typos and errors
• Add missing information
• Improve clarity
• Add examples

4. Write Code

Ready to code? Here’s how:

1. Check open issues
2. Look for good first issue labels for beginner-friendly tasks
3. Comment on the issue to claim it
4. Follow the PR process below

Getting Started

Prerequisites

• Node.js 18+
• Git
• GitHub account

Fork and Clone

1. Fork the repository on GitHub
2. Clone your fork:

git clone https://github.com/YOUR-USERNAME/CoogCasa.git
cd CoogCasa

3. Add upstream remote:

git remote add upstream https://github.com/KevinTrinh1227/CoogCasa.git

Set Up Development Environment

# Website
cd web
npm install
npm run dev

# Docs
cd ../docs
npm install
npm run dev

Create a Branch

Always create a branch for your work:

git checkout -b feature/your-feature-name
# or
git checkout -b fix/bug-description

Branch naming conventions:

• feature/ - New features
• fix/ - Bug fixes
• docs/ - Documentation changes
• refactor/ - Code refactoring
• style/ - UI/styling changes

Making Changes

1. Write Code

Follow our code style guide.

2. Test Your Changes

npm run build  # Ensure it builds
npm run lint   # Check for lint errors
npm run test   # Run tests (if available)

3. Commit Your Changes

Write clear commit messages:

git commit -m "feat(web): Add scholarship search filter

- Add GPA filter dropdown
- Add deadline filter
- Update API client to support filters

Closes #123"

Commit message format:

<type>(<scope>): <description>

[optional body]

[optional footer]

Types: feat, fix, docs, style, refactor, test, chore

4. Stay Updated

Keep your branch up to date:

git fetch upstream
git rebase upstream/main

5. Push and Create PR

git push origin feature/your-feature-name

Then create a Pull Request.

Code of Conduct

Be Respectful

• Treat everyone with respect
• Be constructive in feedback
• Welcome newcomers

Be Helpful

• Answer questions when you can
• Share knowledge
• Help others succeed

Be Professional

• Focus on the work, not personalities
• Accept constructive criticism
• Take responsibility for mistakes

Communication

GitHub Issues

• Primary place for bug reports and feature requests
• Use clear titles and descriptions
• Search before opening new issues

Discord

• Real-time discussion
• Quick questions
• Community chat

Recognition

Contributors are recognized in:

• Release notes
• CONTRIBUTORS.md file
• Community shoutouts

Questions?

• Check the documentation first
• Search existing issues
• Ask on Discord
• Open a new issue

Thank you for contributing to CoogCasa! Your help makes a difference for UH students. 🐾