Ruby Australia Website

Welcome to the Ruby Australia website repository! This project welcomes contributors of all experience levels.

Getting Started

👉 New to the project? Check out CONTRIBUTING.md for detailed setup instructions and contribution guidelines.

👉 Want mentoring support? Join our Mentored Contributions Program to get paired with an experienced Rubyist.

👉 Questions? Join us on Ruby Australia Slack in the #org-web channel.

Project Overview

This is a Rails 8.0+ application managing multiple Ruby community sites:

• Main App: Core Ruby Australia website at ruby.org.au
• City Sites: City-specific sites in the sites/ directory (e.g., melbourne.ruby.org.au)

Tech Stack: Rails + Vite + Hotwire + TailwindCSS + PostgreSQL

Development

Setup:

bin/install-hooks  # First time only
bin/setup          # Install dependencies and prepare database

Run the app:

bin/dev  # Starts Vite + Puma + background jobs

Run tests:

bin/tests   # Full test suite (RSpec + Rubocop)
bin/rspec   # RSpec only

For detailed setup instructions, troubleshooting, and contribution guidelines, see CONTRIBUTING.md.

Deployment

Hosted on Heroku with automatic deployment from the main branch.

Live site: ruby.org.au

Releases and Versioning

Versioning is automated via GitHub Actions when code is merged into main. We follow Semantic Versioning.

The version bump is determined by the commit messages:

• Major (x+1).0.0: Add #major to your commit message (e.g., Refactor user auth system #major).
• Minor x.(y+1).0: Add #minor to your commit message (e.g., Add user profile page #minor).
• Patch x.y.(z+1): Default behavior for all other commits.

A new GitHub Release and Git Tag are automatically created for every push to main that successfully passes CI.

Good to know

• We use Sitemaps to help search engines discover our content. You can generate a new sitemap by running bin/rails sitemap:refresh.
• We use GitHub Issues to track bugs, enhancements, and feature requests. Feel free to browse the issues and contribute.
• Our issue labels include: good first issue, help wanted, bug, enhancement, and more. Check the Issues for details.
• We have a Code of Conduct that all contributors must follow to maintain a welcoming and inclusive community.
• We encourage open communication and collaboration. If you have any questions or need help, don't hesitate to reach out on our Slack or open an issue.
• We appreciate all contributions, whether it's code, documentation, bug reports, or just spreading the word about our project. Every contribution helps us grow and improve!
• We have a Mentored Contributions Program to support new contributors. If you're new to open source or want guidance, consider joining the program to get paired with an experienced mentor.
• We use GitHub Actions to automate our development workflow and ensure code quality standards are met.
• We have a comprehensive CONTRIBUTING.md file that outlines our contribution guidelines, development workflow, and code quality standards. Please review it before submitting a pull request.
• We encourage contributors to write clear and descriptive commit messages, as they help maintain a clean and understandable project history. A good commit message should explain the "what" and "why" of the changes being made.

Contributing

We welcome contributions of all kinds! See CONTRIBUTING.md for:

• Detailed setup instructions
• Development workflow
• Code quality standards
• How to submit pull requests

All contributors must follow our Code of Conduct.

CodeTriage

Want to help out but not sure where to start? Subscribe via CodeTriage to receive a regular email highlighting open issues you can help with.

License

• Content: Copyright 2016 by Ruby Australia, All rights reserved
• Logotype: "Ruby Australia" 'Gem' and Typographic logo are Copyright 2016 by Ruby Australia, all rights reserved