Skip to content

Latest commit

 

History

History
81 lines (60 loc) · 3.72 KB

CONTRIBUTING.md

File metadata and controls

81 lines (60 loc) · 3.72 KB
Raw

✨ Contributing Guide

First of all, thank you for taking the time to contribute! 🎉
The following is a set of guidelines for contributing to this repository.
Before contributing, we encourage you to read our Code of Conduct.

📝 Contributing to the repository

  • Cloning the Repository (repo)
  • Making your Changes
  • Opening a Pull Request

Cloning the Repository

1. Fork the Repository

Click the fork button at the top right of the page to create a copy of this repo in your account, or go to this repository's fork page. After successfully forking the repo, you will be directed to your repo copy.

2. Clone the Forked Repository

On your forked repo, click the green button that says Code. It will open a dropdown menu. Copy the link in the input with the label HTTPS or GitHub CLI depending on your preferred cloning mode.

For HTTPS, open up your terminal and run the following command:

git clone <your-clone-link>
# or
git clone https://github.com/<your-username>/FakeJobs-Api.git

Replace <your-username> with your GitHub username.

You can also clone the repo using the GitHub CLI. To do this, run the following command:

gh repo clone <your-username>/FakeJobs-Api

Making your Changes

1. Create a New Branch

Create a new branch from the main branch. Your branch name should be descriptive of the changes you are making along with your first name. Some ideas to get you started:

  • For documentation: docs-<your-first-name>
  • For adding new features: new-f-<your-first-name>

To create a new branch, use the following command:

git checkout -b <your-branch-name>

2. Make your Changes

Work on the code on your local machine.

Important

You are to make only one contribution per pull request. It makes it easier to review and merge. If you want to add multiple new questions or if you have solved multiple issues, create separate pull requests for each.

Note

Before you begin with coding, please ensure that you create a new issue detailing the new feature you wish to implement and get assigned to it. Pull requests will only be accepted if the code address the existing issue assigned to you. Furthermore, if there are other existing issues you'd like to contribute to, you can request to be assigned to them.

3. Commit your Changes

Your commit message should give a concise idea of the issue you are solving. Please be specific about the commit message.

To commit your changes, run the following command:

git add .
git commit -m "<your_commit_message>"

Eg:

git commit -m "adding new questions to GitOps Fundamentals Level 1"

Push your local commits to your remote repository.

git push origin <your-branch-name>

Opening a Pull Request(PR)

1. Create a new Pull Request(PR)

Go to the FakeJobs-Api repository and click the compare & pull request button or go to the Pull Request page and click on the New pull request button. It will take you to the Open a pull request page.

Note: Make sure your PR points to the main branch, not any other one.

2. Wait for the Review

🎉 Congratulations! You've made your pull request! A maintainer will review and merge your code or request changes. If changes are requested, make them and push them to your branch. Your pull request will automatically track the changes on your branch and update.