Skip to content

Commit 2a09b6b

Browse files
committed
Add section on contributing
1 parent d4ab2b5 commit 2a09b6b

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This repo is the open source project for the **code curious app** that aims to h
1414
## How to set up
1515

1616
1. Clone the repo (`git clone <repo-url>`)
17-
1. Change into the project directory (`cd rgbapp`)
17+
1. Change into the project directory (`cd cc-app`)
1818
1. Run `bundle install`. This can fail for a number of reasons. See below for some troubleshooting.
1919
1. Run `(bundle exec) rake db:create`. This will create the databases for `development` and `test` by default.
2020
1. Install imagemagick (e.g. `brew install imagemagick`)
@@ -168,3 +168,21 @@ If this is the case try `$ bundle update` and then run `$ bundle exec rake -T` i
168168
1. Pull the latest changes.
169169
1. Push to Heroku using `git push heroku master`.
170170
1. If necessary, run migrations using `heroku run rails db:migrate`.
171+
172+
## Contributing
173+
174+
Welcome! We're happy that you will help us improve our app. Please let us know, if you have any questions.
175+
176+
**Choose or open an issue**
177+
178+
If you want to contribute, feel free to assign yourself to an existing issue or open a new one.
179+
180+
**Create your own branch**
181+
182+
1. Clone the repository.
183+
1. `git checkout -b <your-name>-<feature-name>` to a new branch in your local repository.
184+
1. Make your changes.
185+
1. `git commit -m` 'Add commit message'
186+
1. `git push` to push your new branch to your GitHub repository.
187+
188+
When you have made your changes and tested them, please send us a pull request for review.

0 commit comments

Comments
 (0)