Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
83 lines (65 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

83 lines (65 loc) · 1.67 KB

Contributing to Auto-Fill-Tool

First off, thank you for considering contributing to Auto-Fill-Tool! We welcome contributions of all sizes, from fixing typos to adding new features.

🚀 Getting Started

1. Fork and Clone

  1. Fork the repository on GitHub by clicking the Fork button.
  2. Clone your fork locally:
   git clone https://github.com/YOUR-USERNAME/Auto-Fill-Tool.git
   cd Auto-Fill-Tool
  1. Add upstream remote:
   git remote add upstream https://github.com/sunilkumar2170/Auto-Fill-Tool.git

2. Install Dependencies

npm install

3. Create a Branch

git checkout -b my-new-feature

Use descriptive names (e.g., fix/header-typo, feature/dark-mode, docs/update-readme).

💻 Development Workflow

npm run dev

Open http://localhost:3000 in your browser.

Linting

npm run lint

Testing

npm test

📁 Project Structure

  • src/app/ — Next.js pages
  • src/app/components/ — Reusable React components
  • src/app/lib/ — Utility functions, Redux slices
  • public/ — Static assets

📬 Submitting a Pull Request

  1. Commit your changes:
   git add .
   git commit -m "feat: add dark mode toggle"
  1. Sync with upstream:
   git fetch upstream
   git rebase upstream/main
  1. Push to your fork:
   git push origin my-new-feature

  1. Open a PR on: https://github.com/sunilkumar2170/Auto-Fill-Tool

  2. Describe your PR clearly:

    • What did you fix or add?
    • Attach screenshots (before & after)
    • Mention the issue number (e.g., Closes #17)

🤔 Need Help?

Open an issue and ask — we are happy to help!

Happy coding! 🎉