Skip to content

Latest commit

 

History

History
128 lines (96 loc) · 5.89 KB

Contributing.md

File metadata and controls

128 lines (96 loc) · 5.89 KB

How to make your first pull request on GitHub

What is forking?

When we love someone’s repository and would like to have it in our GitHub account, we fork it so that we can work with it separately.
When we fork a repository, we get an instance of that entire repository with its whole history. After forking, we can do whatever we want to do without affecting the original version.

What is a pull request?

Pull requests are the way we contribute to group projects or open source projects.
For instance, a user Harry forks a repository of ThanoshanMV and makes changes to that repository. Now Harry can make a pull request to ThanoshanMV, but it’s up to ThanoshanMV to accept or decline it. It’s like saying, “ThanoshanMV, would you please pull my changes?”

What it means to contribute?

Not only can we contribute to an open source project with code, but we can also contribute in many other ways. Some of these ways are described below.
We can contribute to an open source project in the following ways:

1. Designing: You can construct the layouts of a project to improve its usability, improve the project’s navigation and menu based on user research programs, create art for logos or t-shirts, and provide style guides for the project.

2. Writing: You can write and improve the project’s documentation or translate the documentation, start a newsletter for the project or write tutorials for the project and curate highlights from the mailing list, or curate a folder of examples showing how the projects are used.

3. Organizing: You can link duplicate issues, suggest new issue labels, suggest to close old open issues and ask questions on recently opened issues to move the discussion forward.

4. Help others: Answer questions on open issues, review code on other people’s submissions and offer to mentor another contributor.

5. Coding: Help solve any open issues, ask if you can provide any new features and improve tooling and testing.

Let’s make our first pull request!

If you’re not very familiar with Git & GitHub, please check out this session.

1. Fork the repository
Fork the repository by clicking the fork button on the top of the page. This will create an instance of that entire repository in your account.

image

2. Clone the repository
Once the repository is in your account, clone it to your machine to work with it locally.

To clone, click on the clone button and copy the link.

image

Open the terminal and run the following command. It will clone the repository locally.

$ git clone https://github.com/Club-TechBrewers/Club-TechBrewers.github.io.git

We need to go to that cloned directory by running this command:

$ cd /Club-TechBrewers.github.io
3. It’s good practice to create a new branch when working with repositories, whether it’s a small project or contributing to a group's work.

Branch name should be short and it should reflect the work we’re doing.

Now create a branch using the git checkout command:

$ git checkout -b [Branch Name]
4. Make essential changes to the project and save it.

Then execute '$ git status', and you’ll see the 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 "Enter your commit message here" 
5. Push changes to GitHub
In order to push the changes to GitHub, we need to identify the remote’s name.

$ git remote

After identifying the remote’s name we can safely push those changes to GitHub.

Issues and Pull Requests

Creating an Issue

Before creating an Issue for features/bugs/improvements please follow these steps:

  1. Search existing Issues before creating a new issue (has someone raised similar issue already)
  2. If it doesn't exist create a new issue by giving as much context as possible
  3. Please specify the correct Issue type in issue title, if the issue is a feature/improvement mention [Feature] <Issue_title>, if it is a bug mention [Bug] <Issue_title> (for example [Feature] Update readme.md file with steps to clone the project)

Working on an Issue (get it assigned to you)

Before working on an existing Issue please follow these steps:

  1. Only ask to be assigned 1 issue at a time
  2. Comment asking for the issue to be assigned to you (do not tag maintainers on GitHub as all maintainers receive your comment notifications)
  3. Only start working on this Issue (and open a Pull Request) when it has been assigned to you - this will prevent confusion, multiple people working on the same issue and work not being used
  4. Reference the Issue in your Pull Request (for example closes #123 or fixes #123)

Reviewing Pull Requests

We welcome everyone to review Pull Requests, it is a great way to learn, network and support each other.

DOs

  • Be kind and respectful, we use inclusive, gender neutral language (for example they/them instead of guy/man)
  • Use inline comments to explain your suggestions
  • Use inline suggestions to propose changes

DON'Ts

  • Do not be rude, disrespectful or aggressive
  • Do not repeat feedback, this creates more noise than value (check the existing conversation), use GitHub reactions if you agree/disagree with a comment
  • Do not blindly approve pull requests to improve your GitHub contributors graph

Note: Persistent non-compliance with this Contributing Guide can lead to a warning and/or ban under the Code of Conduct