Skip to content

Latest commit

 

History

History
101 lines (64 loc) · 3.1 KB

CONTRIBUTING.md

File metadata and controls

101 lines (64 loc) · 3.1 KB
Raw

Here's the revised CONTRIBUTING.md file with your additional instructions:

Contributing to LinkedIn Resume Builder 🤝

Thank you for your interest in contributing to the LinkedIn Resume Builder project! We appreciate your help in making this project better. Please follow the guidelines below to ensure a smooth contribution process.

Table of Contents 📚

Forking the Repository 🍴

  1. Click on the Fork button at the top right corner of the repository page.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/your-username/linkedin-resume-builder.git

  3. Navigate to the project directory:

    cd linkedin-resume-builder

Submitting Issues 🐛

If you find a bug or have a feature request, please submit an issue by following these steps:

  1. Navigate to the Issues tab of the repository.
  2. Click on the New Issue button.
  3. Fill out the issue template with the necessary details. Please include:
    • A brief description of the issue.
    • Screenshots (if applicable) to illustrate the problem.

Submitting Pull Requests 🔄

To submit a pull request:

  1. Star the Repository ⭐: If you find this project helpful, please star the repository to show your support!

  2. Ensure your fork is up to date with the main repository:

    git checkout main
git pull upstream main

  3. Create a new branch for your feature or fix:

    git checkout -b your-branch-name

  4. Make your changes and commit them:

    git add .
git commit -m "Add a brief description of your changes"

  5. Push your branch to your forked repository:

    git push origin your-branch-name

  6. Go to the original repository and create a pull request. In your pull request:

    • Write a brief description of the changes.
    • Include before and after screenshots (if applicable).
    • Mention the issue number that your pull request addresses.

  7. After your pull request is merged, please delete your forked repository and fork it again to avoid clashes when merging other issues.

Coding Style and Best Practices 💻

  • Follow the JavaScript Standard Style for coding conventions.
  • Write clear and concise commit messages.
  • Ensure your code is well-documented and easy to understand.
  • Add screenshot in issue and pr description.

Code of Conduct 📜

By participating in this project, you agree to abide by the Code of Conduct. Please treat everyone with respect and kindness.

Thank you for contributing to the LinkedIn Resume Builder project! We appreciate your help in making it a better resource for everyone. If you have any questions, feel free to reach out!