Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
100 lines (64 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

100 lines (64 loc) · 2.89 KB

Contributing Guidelines

🎉 Whether it's fixing a bug, adding a feature, or improving documentation — every contribution matters.

🛠 How to Contribute

Thank you for your interest in contributing to this project! Follow the steps below to make your contribution smoothly and effectively:

⭐ 1. Star and Fork the Repository

  • Star this repository to show your support!
  • Click on the Fork button at the top-right corner of the repository page. This will create a copy of the repository under your GitHub account.

🐛 2. Create or Claim an Issue

  • Go to the Issues tab and check if the task/feature/bug you want to work on already exists.
  • If not, click on "New Issue" and clearly describe your suggestion or bug.
  • Wait for a maintainer to assign you the issue before starting work. This helps avoid duplicate work and ensures coordination.

📝 Steps to Contribute

  1. Fork the Repository
    Click the "Fork" button on the main repository.

  2. Clone Your Fork

    git clone https://github.com/your-username/Resume-Generator.git
cd Resume-Generator

    Replace your-username with your GitHub username.

  3. Create a New Branch Always create a new branch before making changes:

    git checkout -b your-feature-branch

    Use a descriptive name like feature/toggle animation or fix/header-alignment.

  4. Make Your Changes

    Work on the feature or bug assigned to you.

    Make sure your code is clean, well-commented, and follows the project’s coding standards.

    If necessary, update documentation or add helpful comments.

  5. Stage and Commit Changes

    git add .
git commit -m "Your meaningful commit message"

  6. Push the branch to your GitHub fork

    git push origin feature/your-branch-name

  7. Create a Pull Request(PR)

    Open your forked repository on GitHub.

    Click the "Compare & pull request" button.

    Write a clear and concise title and description for your PR.

    Submit the PR.

⏳ 8. Wait for Review

A project maintainer will review your pull request.

You may be asked to make changes — don’t worry, that’s part of the collaborative process.

Once approved, your code will be merged into the main branch.

💡 Additional Tips

Always sync your fork with the upstream repository to stay updated.

Be polite and collaborative in your interactions.

If you're new to open source, don't hesitate to ask for guidance — we're here to help!

To run locally

Clone the repository:

git clone https://github.com/rajdeep13-coder/Resume-Generator.git
cd Resume-Generator
# Open in browser
Open index.html in your preferred web browser

💡 Need Help?

If you have questions, open an issue or join the discussions.

Thank you for making Resume-Generator better! 🌟