Skip to content

Latest commit

 

History

History
85 lines (56 loc) · 1.86 KB

CONTRIBUTTING.md

File metadata and controls

85 lines (56 loc) · 1.86 KB

Class project

Welcome to the Class project repository! Follow the steps below to contribute to this project.

Prerequisites

  • Git installed on your machine
  • A GitHub account
  • Basic understanding of Git commands

How to Contribute

1. Fork the Repository

  • Click the "Fork" button at the top right of this repository

2. Clone the Repository

  1. Open your terminal or command prompt.

  2. Run the following command:

    git clone https://github.com/bhantsi/class-practice-collab.git
    cd class-project

3. Navigate to the Project Directory

cd class-practice-collab

4. Create a New Branch

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

    git switch -c feature/your-feature-name
  2. Use a descriptive branch name (e.g., feature/add-login or fix/typo-in-readme).

5. Make Your Changes

  1. Open the project in your preferred code editor.
  2. Make the necessary changes to the codebase.

6. Stage Your Changes

  1. Check which files you modified:

    git status
  2. Stage the changes you want to commit:

    git add .

    (This stages all modified files. Replace . with a specific file name to stage only that file.)

7. Commit Your Changes

  1. Write a descriptive commit message:

    git commit -m "Brief description of changes"

8. Push Your Changes

  1. Push your branch to the remote repository:

    git push origin feature/your-feature-name

9. Open a Pull Request (PR)

  1. Go to the repository on GitHub.
  2. Navigate to the Pull Requests tab.
  3. Click New Pull Request.
  4. Select your branch and the branch you want to merge into (usually main or develop).
  5. Provide a clear title and description for your pull request.
  6. Submit the pull request for review.