Skip to content

Commit

Permalink
⏪️ Bring back "You can help" section
Browse files Browse the repository at this point in the history
  • Loading branch information
pboling committed Mar 23, 2024
1 parent 0058037 commit 050fe8b
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,24 @@ See [CONTRIBUTING.md][🤝contributing]

[🤝contributing]: CONTRIBUTING.md

### You can help!

Take a look at the `reek` list which is the file called `REEK` and start fixing things.

To refresh the `reek` list:

`bundle exec reek > REEK`

Then follow these instructions:

1. Fork the repository
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Make some fixes.
4. Commit your changes (`git commit -am 'Added some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
7. Create new Pull Request.

## 🌈 Contributors

[![Contributors][🌈contrib-rocks-img]][🐙hub-contrib]
Expand Down

0 comments on commit 050fe8b

Please sign in to comment.