Skip to content

Latest commit

 

History

History
112 lines (78 loc) · 4.82 KB

Contributing.md

File metadata and controls

112 lines (78 loc) · 4.82 KB
Raw

Contributing to HireHub

Thank you for your interest in contributing to HireHub! We appreciate all contributions, whether they're bug fixes, new features, documentation improvements, or any other enhancements.

Please follow the guidelines below to ensure a smooth contribution process.

1. Understanding the Project Structure

Before contributing, take time to familiarize yourself with the structure of the project by reading the README file. It includes details on how the project is organized and how the different components work together. Understanding the structure will help you contribute effectively.

2. How to Contribute

Step 1: Identify an Issue

First, check for any existing issues in the repository. If you want to report a new issue, please make sure to follow the Issue Template provided below:

Issue Template:

  • Issue Title: A concise and descriptive title.
  • Description: Clear and detailed description of the issue or feature request.
  • Steps to Reproduce (if applicable): Detailed steps to reproduce the issue.
  • Expected Behavior: What you expected to happen.
  • Actual Behavior: What actually happened.

If the issue already exists or you're interested in fixing something, feel free to pick it up.

Step 2: Fork the Repository

Once you have identified the issue or feature you want to work on:

  1. Fork this repository to your GitHub account by clicking the "Fork" button in the top right.
  2. Clone your forked repository to your local machine: 
    git clone https://github.com/YOUR-USERNAME/hiring-portal.git
  3. Navigate to the project directory: 
    cd hiring-portal

Step 3: Create a New Branch

Before making changes, create a new branch for your feature or bug fix:

git checkout -b feature/your-feature-name

Step 4: Make the Necessary Changes

Work on your branch to make the required changes. Ensure that your code follows these guidelines:

  • Code Quality: Maintain clean, modular, and efficient code. Comment your code where necessary.
  • Structure: Follow the existing folder and component structure to keep things consistent.
  • Testing: Test your code thoroughly to ensure there are no bugs or issues.
  • Screenshots or Videos: Take screenshots or record a short video of your changes to demonstrate what you worked on.

Step 5: Commit and Push Your Changes

Once your changes are complete, commit them with a clear and concise message:

git commit -m "Add feature/your-feature-name"

Push the changes to your forked repository:

git push origin feature/your-feature-name

Step 6: Create a Pull Request (PR)

Go to the original repository and click "Compare & Pull Request". When submitting the PR, please follow this PR Format:

Pull Request Template:

  • Title: Short and descriptive title for your pull request.
  • Description: Detailed description of what changes you made and why.
  • Screenshots/Video: Attach screenshots or a video showcasing your changes.
  • Issue Reference: Mention the issue number this PR addresses (if applicable).

Step 7: Code Review & Feedback

The project maintainers will review your pull request. You may be asked to make some changes before your PR can be merged. Please respond to the feedback and make the necessary adjustments.

If you have any questions or doubts during the review process, feel free to ask.

Contribution Guidelines

  1. Understand the Project Structure: Refer to the README to understand how the project is structured.
  2. Raise an Issue: If you're working on an issue, follow the issue template, or pick an existing issue.
  3. Fork and Branch: Fork the repository, create a new branch, and make your changes.
  4. Code Quality: Ensure your code is clean, modular, and well-tested.
  5. PR Guidelines: Follow the PR template and include relevant screenshots or videos of your work.
  6. Ask for Help: If you have any doubts or questions at any stage, don't hesitate to ask for help by creating an issue or commenting on your PR.

Example Screenshots

Make sure to include screenshots of the changes you make, for example:

  • Before and after comparison of a UI change
  • Screenshots showing the new feature you added
  • Video showing the functionality of your new feature

These visual aids will help reviewers understand your changes quickly.

Thank You for Contributing!

We greatly appreciate your contributions to HireHub. If you have any doubts or need clarification at any point, please feel free to reach out by creating an issue or asking a question in the PR comments.

Happy coding!

This document ensures that contributors understand how to get started, work within the project's guidelines, and maintain quality contributions.