Thank you for interest in contributing to Joy of Rails. Please take a moment to review this document before submitting a pull request.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
Joy of Rails is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from improving the documentation, fixing typos, submitting bug reports and feature requests or writing code which can be incorporated into the application itself.
Please ask first before starting work on any significant new features.
It's never a fun experience to have your pull request declined after investing a lot of time and effort into a new feature. To avoid this from happening, we request that contributors create a feature request to first discuss any new ideas. Your ideas and suggestions are welcome!
Please ensure that the tests are passing when submitting a pull request. If you're adding new features, please include tests.
Working on your first pull request? You can learn how from these friendly tutorials:
- https://makeapullrequest.com/
- https://www.firsttimersonly.com/
- https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github
For any questions, support, or ideas, etc. please create a GitHub discussion. If you've noticed a bug, [please submit an issue][new issue].
If this is something you think you can fix, then fork Joy of Rails and create a branch with a descriptive name.
Make sure you're using the correct Ruby version and Node version.
Run the installation script to get the application set up:
bin/setupNow you should be able to run the entire suite using:
bin/verifyAt this point, you're ready to make your changes. Feel free to ask for help.
Make sure to take a look at your changes in a browser. To boot up the Rails development server and supporting processes:
bin/devYou should now be able to open http://localhost:3000 in your browser.
If desired, open the Rails console with:
bin/rails consoleTo migrate the database for a new migration:
bin/rails db:migrateAt this point, if your changes look good and tests are passing, you are ready to create a pull request.
Github Actions will run our test suite.
A PR can only be merged into the main branch by a maintainer if: CI is passing, approved by a maintainer, and is up to date with the default branch.