Skip to content

Latest commit

 

History

History
97 lines (62 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

97 lines (62 loc) · 2.59 KB

Contributing to Course App

Thank you for your interest in contributing to this repo! We welcome contributions from the community to help improve and enhance the project. Please take a moment to read through the following guidelines to get started.

Table of Contents

Getting Started

Before you start contributing to the project, make sure you have:

  • A GitHub account.
  • Git installed on your local machine.
  • Node.js and npm (Node Package Manager) installed on your local machine.
  • Yarn installed on your local machine.

Contributing Guidelines

We follow these guidelines for contributing:

  1. Fork the repository to your GitHub account.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/yourusername/Human_mg.git

  3. Navigate to the project directory:

    cd Human_mg

  4. Create a new branch for your contribution:

    git checkout -b feature/your-feature-name

  5. Make your changes and ensure your code follows our coding standards and practices.

  6. Test your changes locally to ensure they work as expected.

  7. Commit your changes with clear and concise commit messages:

    git commit -m "Add feature: your feature description"

  8. Push your changes to your GitHub fork:

    git push feature/your-feature-name

  9. Create a pull request (PR) to the main repository's main branch.

Setting Up the Development Environment

To set up the development environment locally, follow these steps:

  1. Clone the frontend repository:

    git clone https://github.com/yourusername/Human_mg.git
cd Human_mg

  2. Install project dependencies using npm:

    npm install

  3. Start the development server:

    npm run dev

    The project will be accessible at http://localhost:5173/.

Submitting a Pull Request (PR)

When you're ready to submit your changes, create a pull request (PR). Be sure to provide a clear description of your changes in the PR, and one of our maintainers will review it.

Backend Reference Link

You can find the reference link to the backend of the reivew-app here: https://codehelp-apis.vercel.app/api/get-top-courses

We appreciate your contributions and look forward to collaborating with you!