Skip to content

Latest commit

 

History

History
101 lines (66 loc) · 4.02 KB

CONTRIBUTING.md

File metadata and controls

101 lines (66 loc) · 4.02 KB

Contributing Guidelines

First of all thanks for spending your time to contribute or showing interest to contribute to this project 😃

This documentation contains a set of Guidelines and Steps to help you during the contribution process.

🔑 Guidelines for contributing :

Here are some set of guidelines to follow while contributing to rbjks.github.io :

  1. Welcome to this repository, if you are here as an open-source program participant/contributor.
  2. Participants/contributors have to comment on issues they would like to work on, and mentors or the maintainers will assign you.
  3. Issues will be assigned on a first-come, first-serve basis.
  4. Participants/contributors can also open their issues. We respect all your contributions, whether it is an Issue or a Pull Request.
  5. Please check if the issue you want to is already listed, If its already listed, chat in the comments to figure out whether someone is working on it or not. If issue is not listed then you can raise an issue, make sure you get it assigned to you before you start working on that project.
  6. Please don't pick up an issue already assigned to someone else. Work on the issues after it gets assigned to you.
  7. Create your file in an appropriate folder with appropriate name and extension.
  8. Pull requests will be merged after appropriate reviews.
  9. We all are here to learn. You are allowed to make mistakes. That's how you learn, right!.

▶️ Steps for contributing :

Fork this repository

image


Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.

Clone This Repository

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

git clone https://github.com/<Your-Github-username>/rbjks.github.io.git

Create a branch

Change to the repository directory on your computer (if you are not already there):

cd rbjks.github.io

Now create a branch using the git checkout command:

git checkout -b <branch-name>

For example:

git checkout -b add-new-feature

Make necessary changes and commit those changes

If you go to the project directory and execute the command git status, you'll see there are changes.

Add those changes to the branch you just created using the git add command:

git add .

Now commit those changes using the git commit command:

git commit -m "Your commit message"

Push changes to GitHub

Push the changes to the forked repository using:

git push origin <Your-branch-name>

Navigate to the original fork of this repository on your profile and click on the branch you had committed to. Then click on Contribute to create a Pull Request i.e create a PR on Github. (Don't just hit the create a pull request button, you must write a PR message to clarify why and what are you contributing)

In case of merge conflict fetch and merge from the remote repository .

Are you a beginner in using Github?

You can refer to the following articles on the basics of Git and Github and also contact me, in case you are stuck: