Skip to content

Home

Jump to bottom
Tom Calver edited this page Oct 27, 2024 · 3 revisions

Roky is a robust, open-source desktop chat application developed in Kotlin. Its focus is on delivering a high-quality, secure, and efficient user experience. Roky runs on all standard desktop operating systems and is designed as a terminal-based application. We aim to develop an application that meets industry standards while remaining accessible to contributors interested in collaborating on a meaningful project.

Project Overview

Roky’s first version includes:

  • User Authentication: Log in securely with predetermined accounts.
  • Single Chat Room: Collaborate and communicate in a single room with other Roky users.
  • Customisation: Change your username within the app.
  • Help & About: Access basic commands for help and information.

While our current focus is on a terminal-based application, Roky’s architecture supports future enhancements, including a graphical frontend (JavaFX) and mobile applications.

Getting Started

Development primarily occurs through group coding sessions scheduled through a shared Google Calendar and WhatsApp group chat. Our Getting Started guide explains how to access the calendar and set up your development environment. Our team regularly hosts planning meetings and collaborative coding sessions, where all contributors can gain insight into project goals, progress, and opportunities for meaningful contributions.

How We Work

Our development practices emphasise speed through quality. We adhere to several industry best practices, including using Git Flow, continuous integration (CI), and unit testing to ensure every update to Roky is reliable and maintainable. Collaborative coding sessions, which include pair/mob programming, are scheduled regularly to support cohesive project progress, foster innovation, and streamline code quality. You can visit our How We Work page for details on participation, roles, and expectations.

Contribution Guidelines

We follow established contribution guidelines to maintain quality and consistency, including branch naming conventions, commit message format, and more. Please have a look at our Contribution Guidelines to understand our expectations for coding standards and workflow practices.

Community Values

We believe in fostering a professional and welcoming project environment. Contributors are encouraged to:

  • Collaborate openly and respectfully, with patience toward others.
  • Try to attend planning meetings and RSVP to events on our shared Google Calendar to stay in sync with the team.
  • Focus on producing high-quality code that aligns with our standards, ensuring Roky’s reliability and usability.

Quick Links

Clone this wiki locally