Skip to content

Commit 6c6b052

Browse files
khwiloleesharma
authored andcommitted
Add details to CONTRIBUTING.md (#169)
* Update CONTRIBUTING.md file * Stylistic/grammatical changes to CONTRIBUTING It looks like repository owners might be able to commit back to the PR branch, so I'm giving it a try. This commit implements the changes requested in #169. After this, I think it's ready to be merged!
1 parent d22b9cc commit 6c6b052

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

.github/CONTRIBUTING.md

+35
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,38 @@ least one other person on the team needs to look over a PR before merging. The
66
purpose of this review requirement is to ensure shared knowledge of the app and
77
its changes and to take advantage of the benefits of working together changes
88
without any single person being a bottleneck to making progress.
9+
10+
## Steps
11+
12+
1. Fork this repository.
13+
14+
2. Clone the repository by running this command:
15+
```shell
16+
$ git clone https://github.com/YOUR-GITHUB-USERNAME/playtime.git
17+
```
18+
19+
3. Add a remote upstream that points to the original Playtime repository:
20+
```shell
21+
$ git remote add upstream https://github.com/rubyforgood/playtime.git
22+
```
23+
24+
4. Create a new branch to make changes. The branch name should be relevant to
25+
your change (ex. `rubocop` or `setup-mailers`). You can create a new branch
26+
with:
27+
```shell
28+
$ git checkout -b BRANCH-NAME
29+
```
30+
31+
5. Make your modification, make sure the tests pass, and commit the changes
32+
locally:
33+
```shell
34+
$ bundle exec rake
35+
$ git commit
36+
```
37+
38+
6. Push your new branch to GitHub:
39+
```shell
40+
$ git push origin BRANCH-NAME
41+
```
42+
43+
7. Open a pull request on GitHub.

0 commit comments

Comments
 (0)