Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (48 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

69 lines (48 loc) · 1.52 KB

Contributing to Pokémon Stats

Thanks for your interest in contributing! This project is open to collaboration and improvement, especially from fellow Pokémon fans and frontend enthusiasts.

🧩 What You Can Help With

  • Fix bugs 🐞
  • Improve UI or UX 🎨
  • Refactor legacy code 🧼
  • Add support for more Pokémon forms or edge cases 🔍
  • Suggest features or open issues 💡

🚀 Getting Started

  1. Fork the repository
  2. Clone your fork
git clone https://github.com/juandadev/pokemonstats.git
  1. Install dependencies
npm install
# or
pnpm install
  1. Run the app locally
npm run dev

📦 Tech Stack

This project uses:

  • Next.js 14
  • React 18
  • Bootstrap 5
  • PokéAPI (with some local overrides)
  • Deployed on Vercel

🧪 Before Opening a PR

  • Make sure the app runs correctly (npm run dev)
  • Run linter and formatter if available
  • Keep your changes focused and scoped
  • Add comments if you're changing tricky logic
  • Try to follow the project's file and code organization

🙏 Pull Request Etiquette

  • Open a Draft PR if you're still working and want feedback
  • Add a clear title and description to your PR
  • Reference related issues if applicable
  • Be respectful during code review — we're all learning

📬 Need Help?

If you're unsure where to start or want to discuss an idea before coding, feel free to open an issue or start a discussion.

Let’s keep this project welcoming, useful, and fun for everyone. Thanks again for contributing!