CONTRIBUTING.md

Contributing to Chordly

Dependencies:

• Ruby 3.4.5
• PostgreSQL
• Yarn

Writing some code

If you want to fix a bug or add a new feature, please:

1. Fork the project.
2. Create a feature branch (git checkout -b my-new-feature).
3. Make your changes. Include tests for your changes, otherwise I may accidentally break them in the future.
4. Run the tests with the rake command. Make sure that they are still passing.
5. Write descriptive commit messages and follow Angular's commit format e.g. feat: add new feature.
6. Push the branch to GitHub (git push origin my-new-feature).
7. Create a Pull Request and submit it to be merged with the main branch.

Setting up development server

1. Install Ruby dependencies

bundle install

2. Install JavaScript dependencies

yarn install

3. Initialize database and seed with dummy data

./bin/rails db:create db:migrate db:seed

4. Run local server

./bin/dev

5. Open application in your browser: http://localhost:3000

Running tests

rake

Seeding database with example chord sheets and users

./bin/rails db:seed

Deploying

./release.bash [major|minor|patch]
git push origin main --tags