Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #64

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −11
Open

Update README.md #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# First Contributions
First Contributions

| <img alt="RStudio" src="assets/rstudio-logo.png" width="300"> | RStudio Edition |
| ------------------------------------------------------------- | --------------- |
Expand All @@ -13,30 +13,30 @@ This repo is a chopped-up, trimmed-down, and customised-for-RStudio version of t

---

## Introduction
Introduction

It's hard. It's always hard, when you do something for the first time. Especially when you are collaborating, making mistakes isn't a comfortable thing. But open source is all about collaboration & working together. We wanted to simplify the way new open-source contributors learn & contribute for the first time.

Reading articles & watching tutorials can help, but what comes better than actually doing the stuff without messing up anything. This project aims at providing guidance & simplifying the way rookies make their first contribution. Remember the more relaxed you are the better you learn. If you are looking for making your first contribution just follow the simple steps below. We promise you, it will be fun.

---

## What this will teach you
What this will teach you

- How to fork a repo
- How to make a branch
- How to submit a pull request to the original repo

---

## What this won't teach you
What this won't teach you

- How to build R packages
- Open source etiquette

---

## Assumptions
Assumptions

I have made a number of assumptions in writing this guide:

Expand All @@ -49,7 +49,7 @@ OK, let's get started!

---

## Fork this repository
Fork this repository

Fork this repo by clicking on the fork button on the top of this page.

Expand All @@ -67,7 +67,7 @@ You now need to get the URL for your repo. Click "Clone or download" and copy th

---

## Create a new project
Create a new project

In RStudio, go to File -> New Project

Expand All @@ -88,7 +88,7 @@ The repo will now be cloned into whichever folder you specified.

---

## Create a branch
Create a branch

In the "Git" tab in the top-right panel, click the "new branch" button.

Expand All @@ -106,7 +106,7 @@ Make sure that "Sync branch with remote" is checked and click "Create". You may

---

## Make necessary changes and commit those changes
Make necessary changes and commit those changes

Now open the `Contributors.md` file in RStudio and add your name to it, then save the file.

Expand All @@ -122,7 +122,7 @@ You'll see a diff file showing the changes you've made to the file. Add a commit

---

## Push changes to GitHub
Push changes to GitHub

Congratulations, you've committed all the changes to your local copy of your branch of your fork of first-contributions. Now click "Push" to sync your commit to the remote repo.

Expand All @@ -136,7 +136,7 @@ You'll see a box like this if your changes have been pushed successfully. Click

---

## Submit your changes for review
Submit your changes for review

If you go to your repository on github, you'll see a "Compare & pull request" button. Click on that button.

Expand Down