Skip to content

Latest commit

 

History

History
84 lines (55 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

84 lines (55 loc) · 2.56 KB

Contributing to HireHub

Thank you for your interest in contributing to HireHub! We welcome contributions from the community to enhance our platform. Please read the following guidelines to understand how you can help.

Table of Contents

  1. How to Contribute
  2. Code of Conduct
  3. Reporting Issues
  4. Feature Requests
  5. Submitting Code Changes
  6. Code Style Guidelines
  7. License

How to Contribute

  1. Fork the Repository
    Click on the “Fork” button at the top right corner of the repository page to create your own copy of the project.

  2. Clone Your Fork
    Clone your forked repository to your local machine using:

   git clone https://github.com/YOUR_USERNAME/hireHUB-website.git
  • Replace YOUR_USERNAME with your GitHub username.
  1. Create a Branch
  • Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature-name
  1. Make Your Changes
  • Make your desired changes in the codebase. Ensure your changes are well-documented and tested.
  1. Commit Your Changes
  • Commit your changes with a clear message:
git commit -m "Add feature: your feature description"
  1. Push to Your Fork
  • Push your changes to your forked repository:
git push origin feature/your-feature-name
  1. Open a Pull Request
  • Navigate to the original repository and click on the “New Pull Request” button. Select your branch and submit your pull request.

Code of Conduct

We expect all contributors to adhere to our [Code of Conduct]. Please be respectful and considerate in all interactions.

Reporting Issues If you find a bug or have an issue with the project, please report it by creating a new issue in the Issues section of the repository.

Feature Requests

We welcome feature requests! Please submit your ideas as an issue, and we will consider them for future updates.

Submitting Code Changes

  • Follow the Code Style Guidelines
  • Ensure all tests are passing.
  • Add appropriate tests for your changes if applicable.
  • Include documentation for any new features.

Code Style Guidelines

  • Use consistent formatting (you can use Prettier for JavaScript).
  • Follow established naming conventions and code structure.
  • Write clear and concise commit messages.

License

By contributing to HireHub, you agree that your contributions will be licensed under the project's license.