Skip to content

Latest commit

 

History

History
131 lines (81 loc) · 2.66 KB

CONTRIBUTE.md

File metadata and controls

131 lines (81 loc) · 2.66 KB

🌟 Contributing to Fitolution

🎉 Whether it’s fixing a bug, adding a feature, or improving documentation — your contribution is valuable and appreciated.

This guide will help you contribute effectively to the project.

🛠️ How to Contribute

⭐ 1. Star and Fork the Repository

  • Show your support by starring this repository.
  • Fork the repository to your GitHub account using the "Fork" button.

🐛 2. Create or Claim an Issue

  • Check the Issues tab for open issues.
  • If your idea/bug is not listed, open a new issue with a detailed description.
  • Please wait for a maintainer to assign the issue to you before starting work.

📥 3. Clone the Forked Repository

git clone https://github.com/your-username/your-repo-name.git
cd your-repo-name

Replace your-username with your GitHub handle.

🌱 4. Create a New Branch

git checkout -b feature/your-branch-name

Use meaningful names like feature/navbar-fix or enhancement/lint-config.

✏️ 5. Make Your Changes

  • Follow project conventions and clean coding practices.
  • Ensure your code works and passes lint checks.
  • Update documentation if needed.

✅ 6. Stage and Commit

git add .
git commit -m "Add: Implemented feature X"  # or Fix: Corrected issue Y

🚀 7. Push Your Branch

git push origin feature/your-branch-name

🔁 8. Open a Pull Request

  • Go to your fork on GitHub.
  • Click “Compare & pull request”.
  • Write a clear title and description for your PR.
  • Submit the PR and wait for review.

⏳ 9. Wait for Feedback

  • A maintainer will review your PR.
  • You may be asked to revise some parts. That’s normal!

🧠 Tech Stack

This project is built using:

  • React with Vite
  • ESLint (with plugins for better linting rules)
  • (Optionally) Babel or SWC for Fast Refresh

For large-scale projects, TypeScript is recommended.

🧪 Running the Project Locally

  1. Install Dependencies:
npm install
  1. Start Development Server:
npm run dev
  1. Visit http://localhost:5173 in your browser.

🔄 Keeping Your Fork Updated

git remote add upstream https://github.com/original-owner/your-repo.git
git fetch upstream
git checkout main
git merge upstream/main

🤝 Code of Conduct

We’re committed to a respectful and inclusive environment.

➡️ A CODE_OF_CONDUCT.md will soon be added to this repository. Until then, please be kind and professional in all interactions.

Thank you for contributing — we’re glad to have you here! 💙