From 8cf952349d8ea6999c7760210a8e8a348d992386 Mon Sep 17 00:00:00 2001 From: vinayakydv733 Date: Wed, 13 May 2026 00:27:58 +0530 Subject: [PATCH 1/4] docs: add CONTRIBUTING.md guide --- CONTRIBUTING.md | 84 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7696081 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,84 @@ +# Contributing to OpenResume + +First off, thank you for considering contributing to OpenResume! It's people like you that make OpenResume such a great tool for everyone. We welcome contributions of all sizes, from fixing typos to adding new features. + +This document provides a set of guidelines and steps to help you contribute to this project. + +## 🚀 Getting Started + +### 1. Fork and Clone +1. Fork the repository on GitHub by clicking the **Fork** button in the top right corner. +2. Clone your fork locally: + ```bash + git clone https://github.com/YOUR-USERNAME/open-resume.git + cd open-resume + ``` +3. Add the original repository as an upstream remote to keep your fork synced: + ```bash + git remote add upstream https://github.com/xitanggg/open-resume.git + ``` + +### 2. Install Dependencies +Make sure you have [Node.js](https://nodejs.org/) installed. Then run: +```bash +npm install +``` + +### 3. Create a Branch +Always create a new branch for your work: +```bash +git checkout -b my-new-feature +``` +Use descriptive branch names (e.g., `fix/header-typo`, `feature/dark-mode`, `docs/update-readme`). + +## 💻 Development Workflow + +Start the Next.js development server: +```bash +npm run dev +``` +Open [http://localhost:3000](http://localhost:3000) in your browser. The app will automatically reload if you change any of the source files. + +### Code Style & Linting +We use ESLint and Prettier to maintain code quality. Before submitting your code, please run: +```bash +npm run lint +``` +Fix any linting errors that pop up! + +### Testing +We use Jest for unit testing. To run the tests: +```bash +npm test +``` +If you are adding a new feature or utility, please consider adding a test for it! For CI environments, use `npm run test:ci`. + +## 📁 Project Structure Refresher +- `src/app/`: Contains the Next.js App Router pages (`/`, `/resume-builder`, `/resume-parser`, etc.). +- `src/app/components/`: Reusable React components (UI, Form, Resume preview). +- `src/app/lib/`: Utility functions, Redux slices (`redux/`), and the PDF parsing logic. +- `public/`: Static assets like images and fonts. + +## 📬 Submitting a Pull Request (PR) + +1. **Commit your changes**: Make sure your commit messages are clear and descriptive. + ```bash + git add . + git commit -m "Add dark mode toggle button to TopNavBar" + ``` +2. **Sync with upstream**: Before pushing, pull the latest changes from the `main` branch of the original repo: + ```bash + git fetch upstream + git rebase upstream/main + ``` +3. **Push to your fork**: + ```bash + git push origin my-new-feature + ``` +4. **Open a Pull Request**: Go to the original OpenResume repository on GitHub. You should see a prompt to open a PR from your recently pushed branch. +5. **Describe your changes**: Explain what you fixed or added clearly so maintainers can review it easily. + +## 🤔 Need Help? +If you're stuck, feel free to open an issue and ask questions. We are happy to help beginners get started! + +Happy coding! 🎉 From 1dbf6159fe3a3dd62ba61dab23aacf8e0ca0baa5 Mon Sep 17 00:00:00 2001 From: sunil Date: Thu, 14 May 2026 10:55:40 +0530 Subject: [PATCH 2/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7696081..37621b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,12 +10,12 @@ This document provides a set of guidelines and steps to help you contribute to t 1. Fork the repository on GitHub by clicking the **Fork** button in the top right corner. 2. Clone your fork locally: ```bash - git clone https://github.com/YOUR-USERNAME/open-resume.git - cd open-resume +git clone https://github.com/YOUR-USERNAME/Auto-Fill-Tool.git +cd Auto-Fill-Tool ``` 3. Add the original repository as an upstream remote to keep your fork synced: ```bash - git remote add upstream https://github.com/xitanggg/open-resume.git + git remote add upstream https://github.com/sunilkumar2170/Auto-Fill-Tool ``` ### 2. Install Dependencies From 99945029160e70ed1973cdd8faa0bc67cbc4af4d Mon Sep 17 00:00:00 2001 From: sunil Date: Thu, 14 May 2026 11:00:27 +0530 Subject: [PATCH 3/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 83 ++++++++++++++++++++++++------------------------- 1 file changed, 41 insertions(+), 42 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 37621b6..acffcd9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,84 +1,83 @@ -# Contributing to OpenResume +# Contributing to Auto-Fill-Tool -First off, thank you for considering contributing to OpenResume! It's people like you that make OpenResume such a great tool for everyone. We welcome contributions of all sizes, from fixing typos to adding new features. - -This document provides a set of guidelines and steps to help you contribute to this project. +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 in the top right corner. + +1. Fork the repository on GitHub by clicking the **Fork** button. 2. Clone your fork locally: - ```bash -git clone https://github.com/YOUR-USERNAME/Auto-Fill-Tool.git -cd Auto-Fill-Tool - ``` -3. Add the original repository as an upstream remote to keep your fork synced: - ```bash - git remote add upstream https://github.com/sunilkumar2170/Auto-Fill-Tool - ``` +```bash + git clone https://github.com/YOUR-USERNAME/Auto-Fill-Tool.git + cd Auto-Fill-Tool +``` +3. Add upstream remote: +```bash + git remote add upstream https://github.com/sunilkumar2170/Auto-Fill-Tool.git +``` ### 2. Install Dependencies -Make sure you have [Node.js](https://nodejs.org/) installed. Then run: ```bash npm install ``` ### 3. Create a Branch -Always create a new branch for your work: ```bash git checkout -b my-new-feature ``` -Use descriptive branch names (e.g., `fix/header-typo`, `feature/dark-mode`, `docs/update-readme`). +Use descriptive names (e.g., `fix/header-typo`, `feature/dark-mode`, `docs/update-readme`). ## 💻 Development Workflow -Start the Next.js development server: ```bash npm run dev ``` -Open [http://localhost:3000](http://localhost:3000) in your browser. The app will automatically reload if you change any of the source files. +Open http://localhost:3000 in your browser. -### Code Style & Linting -We use ESLint and Prettier to maintain code quality. Before submitting your code, please run: +### Linting ```bash npm run lint ``` -Fix any linting errors that pop up! ### Testing -We use Jest for unit testing. To run the tests: ```bash npm test ``` -If you are adding a new feature or utility, please consider adding a test for it! For CI environments, use `npm run test:ci`. -## 📁 Project Structure Refresher -- `src/app/`: Contains the Next.js App Router pages (`/`, `/resume-builder`, `/resume-parser`, etc.). -- `src/app/components/`: Reusable React components (UI, Form, Resume preview). -- `src/app/lib/`: Utility functions, Redux slices (`redux/`), and the PDF parsing logic. -- `public/`: Static assets like images and fonts. +## 📁 Project Structure -## 📬 Submitting a Pull Request (PR) +- `src/app/` — Next.js pages +- `src/app/components/` — Reusable React components +- `src/app/lib/` — Utility functions, Redux slices +- `public/` — Static assets -1. **Commit your changes**: Make sure your commit messages are clear and descriptive. - ```bash +## 📬 Submitting a Pull Request + +1. Commit your changes: +```bash git add . - git commit -m "Add dark mode toggle button to TopNavBar" - ``` -2. **Sync with upstream**: Before pushing, pull the latest changes from the `main` branch of the original repo: - ```bash + git commit -m "feat: add dark mode toggle" +``` +2. Sync with upstream: +```bash git fetch upstream git rebase upstream/main - ``` -3. **Push to your fork**: - ```bash +``` +3. Push to your fork: +```bash git push origin my-new-feature - ``` -4. **Open a Pull Request**: Go to the original OpenResume repository on GitHub. You should see a prompt to open a PR from your recently pushed branch. -5. **Describe your changes**: Explain what you fixed or added clearly so maintainers can review it easily. +``` +4. Open a PR on: https://github.com/sunilkumar2170/Auto-Fill-Tool + +5. PR description mein likho: + - Kya fix/add kiya + - Screenshots attach karo + - Issue number mention karo (e.g., Closes #17) ## 🤔 Need Help? -If you're stuck, feel free to open an issue and ask questions. We are happy to help beginners get started! + +Open an issue and ask — we are happy to help! Happy coding! 🎉 From f0dd844f8e3b2ffcf6e4b6eae0d65be98a876819 Mon Sep 17 00:00:00 2001 From: sunil Date: Thu, 14 May 2026 11:02:07 +0530 Subject: [PATCH 4/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index acffcd9..160dac9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,10 +71,10 @@ npm test ``` 4. Open a PR on: https://github.com/sunilkumar2170/Auto-Fill-Tool -5. PR description mein likho: - - Kya fix/add kiya - - Screenshots attach karo - - Issue number mention karo (e.g., Closes #17) +5. **Describe your PR clearly:** + - What did you fix or add? + - Attach screenshots (before & after) + - Mention the issue number (e.g., Closes #17) ## 🤔 Need Help?