Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
189 lines (144 loc) · 6.39 KB

CONTRIBUTING.md

File metadata and controls

189 lines (144 loc) · 6.39 KB

🌆 Open Code Chicago – Contribution Guidelines

“Open Source is a city built by everyone.”
Welcome to the Open Code Chicago community — where collaboration meets creativity 💫

All Contributors

Before You Start

  • Please read our Code of Conduct
  • Check out the Usage Guide to run the project locally
  • Look at open issues to see where you can help
  • Review our Project Board to see available tasks
    • Comment on the task you’d like to work on so a maintainer can assign it to you
    • This helps avoid duplicate work and keeps efforts coordinated

How to Contribute

1️⃣ Fork the Repository

Click Fork at the top-right of the repo.

2️⃣ Pick a task

Project Board, comment to claim it before starting work

3️⃣ Clone Your Fork

git clone https://github.com/<your-username>/hacktoberfest-2025-frontend.git
cd hacktoberfest-2025-frontend

4️⃣ Create a Branch

git checkout -b feature/amazing-feature

Use clear, descriptive branch names.

5️⃣ Make Changes

  • Follow project structure & coding style
  • Keep changes focused
  • Run npm run lint & npm run prettier before committing

6️⃣ Commit Your Work

git add .
git commit -m "Fix: navbar transparency on mobile"

6️⃣ Push to Your Fork

git push origin feature/amazing-feature

7️⃣ Open a Pull Request (PR)

  • Base branch: main
  • Describe changes clearly
  • Reference related issues (Closes #123)
  • Keep PRs concise for easy review ✅

Backend & Environment Variables

  • The backend API is available at:
    https://corexshoptest.onrender.com/api
  • The frontend uses the environment variable VITE_API_URL to connect to the backend.
  • Before running the project, copy .env.example to .env: 
    cp .env.example .env
  • You can then use import.meta.env.VITE_API_URL in your code to access the API URL.

Tips & Best Practices

  • Check your environment setup before running the project
  • Please do not install or commit new packages without first discussing in an issue or PR.
  • If you believe a new dependency is required:
    1. Open or comment on an issue explaining why it’s needed.
    2. Wait for maintainer approval before adding it.
  • Keep the repo clean. Do not commit:
    • node_modules
    • package.json
    • package-lock.json
  • Follow project structure. Organize components, pages, and assets properly
  • Document your code clearly
  • Sync with main repo frequently to avoid merge conflicts:
git fetch upstream
git merge upstream/main
  • Test your changes locally before submitting a PR
  • Verify API endpoints if data isn’t loading
  • Ask questions early in Discussions or Discord

Get Recognized with the All-Contributors Bot

We use the All Contributors Bot to recognize and celebrate all types of contributions.

How to add yourself:

  1. After your Pull Request is merged, comment on the PR or in a new issue with:

    @all-contributors please add @your-github-username for code, doc, ideas

  2. The bot will create a Pull Request to add you to the contributors table in the README.

  3. A maintainer will review and merge the bot’s PR.

Example:

@all-contributors please add @Alexandrbig1 for code, doc, maintenance, projectManagement

If you have questions, ask in your PR or open an issue!

💖 Contributor Appreciation

A big thank you to all contributors! 🚀

Issues

  • Use issues to report bugs, request features, or ask questions
  • Before opening a new issue, check if it already exists
  • Apply labels when possible (bug, enhancement, good first issue)

Getting Help

If you’re stuck or unsure:

⭐ Support the Project

If you find this project helpful or enjoy contributing, please consider giving us a ⭐ on GitHub!
Starring the repo helps increase its visibility, attracts more contributors, and makes your contributions more visible and valuable for your portfolio or employer.

Every contribution matters — big or small. ❤️
Thank you for helping make Open Code Chicago better!