Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
119 lines (79 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

119 lines (79 loc) · 2.67 KB
Raw

Contributing to Recruitify

Thank you for considering contributing to our project! We welcome all contributions, whether it's fixing bugs, adding new features, or improving documentation.

Please follow these guidelines for contributing to the repository.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. Running the Project
  4. Making Changes
  5. Submitting a Pull Request
  6. Coding Standards

Code of Conduct

This project follows the Code of Conduct. Please read and follow it to ensure that the community remains welcoming to everyone.

Getting Started

Fork the Repo

  1. Fork this repository by clicking the "Fork" button at the top right of the page.
  2. Create your feature branch: git checkout -b my-feature

Clone the Repo

  1. Clone your fork to your local machine: 
    git clone https://github.com/your-username/your-project-name.git
cd your-project-name

Install Dependencies

We have both client-side and server-side code. You'll need to install dependencies for both.

  1. Install server dependencies:

    cd server
npm install

  2. Install client dependencies:

    cd ../client
npm install

Running the Project

Running the Server

  1. Create a secret.env file in backend directories and add the necessary environment variables as outlined in the .env.example file.
  2. Start the server: 
    npm start

Running the Client

  1. In the client folder, start the React application: 
    npm start

Now you should have both the server and the client running on your local machine.

Making Changes

  1. Make sure your changes are properly tested.

  2. Keep your commits clean and descriptive. A good commit message format is:

    type: subject

description (optional)

    Examples:

    • feat: add login functionality
    • fix: resolve bug in user authentication

Submitting a Pull Request

  1. Ensure your changes are up to date with the main branch: Sync your forked github repository with the main repository

    git fetch origin
git checkout main
git merge origin/main

  2. Push your changes to your feature branch:

    git push origin my-feature

  3. Submit a pull request to the main branch of the original repository.

Make sure to fill out the pull request template and link any related issues.