Skip to content

Update CONTRIBUTING setup and test commands to match current README #2872

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

Merged
mroderick merged 1 commit into from
Sep 13, 2026
+4 −6
Merged

Update CONTRIBUTING setup and test commands to match current README #2872

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
10 changes: 4 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,24 @@
cd planner
```

3. Setup & start the application.
3. Setup & start the application. See the [Quick start](https://github.com/codebar/planner#quick-start) section of the README for full setup instructions (mise, PostgreSQL, ImageMagick). Once set up:

```
bundle
rake db:create db:migrate db:seed
rails server
bundle exec rails server
```

4. Have a look around to get a feel for the app.
5. Run the tests. We only take pull requests with passing tests, and it's great to confirm that you have a clean slate.

```
rake
bundle exec rspec
```

6. Add a test for your change - unless you are refactoring or adjusting styles and documentation. If you are adding any functionality or fixing a bug, we need a test!
7. Implement your change and ensure all the tests pass.
8. Run Rubocop to ensure you are complying with the Ruby style guide. Refer to (https://rubocop.readthedocs.io/en/latest/) for cops/violation details.
```
rubocop
bundle exec rubocop
```
9. Commit, with a meaningful & descriptive message - this is very important!

Expand Down