shepherd/README.md at main · Ibinola/shepherd · GitHub

How to Contribute

A simple guide on how to contribute. Please follow these steps:

1. Fork the Repository

Click on the Fork button at the top right of this repository page to create a copy of the repository in your GitHub account.

2. Clone the Forked Repository

Clone the repository to your local machine using the following command:
```
git clone https://github.com/YOUR-USERNAME/shephard.git
```
YOUR-USERNAME will be your actual GitHub username.

3. Run npm install to install dependencies

npm install

4. Create a New Branch

Navigate to the project directory:
```
cd shephard
```
Create a new branch for the task or page you working on:
```
git checkout -b feature/your-feature-name
```
Name your branch based on the changes/task you are assigned on. For example if I'm working on the NavBar section name your branch
```
git checkout -b feature/nav-bar
```

5. Make Your Changes

Add the files you've worked on
```
git add .
```
Commit your changes with a clear and descriptive commit message.
```
git commit -m "Add detailed description of your changes"
```

6. Push Your Changes to GitHub

Push your branch to your forked repository:

git push origin feature/your-feature-name.

For example:
```
git push origin feature/nav-bar
```

7. Create a Pull Request

Go to the original repository on GitHub.
Click the Compare & pull request button.
Provide a clear title and description for your pull request.
Submit the pull request for review.