Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
90 changes: 90 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
name: Bug report
description: Something in Rexial is not working the way it should
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report this. The more precisely you can
describe what happened, the faster it can be fixed.

- type: textarea
id: what-happened
attributes:
label: What happened?
description: Describe the bug, and what you expected instead.
placeholder: |
When a participant joins with a code that has expired, the screen stays
blank instead of showing an error.
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to reproduce
description: Numbered steps someone else can follow to see the same thing.
placeholder: |
1. Host creates a quiz and generates a join code
2. Wait for the code to expire
3. Open the join page and enter that code
4. Screen goes blank, nothing in the UI explains why
validations:
required: true

- type: dropdown
id: service
attributes:
label: Which part of Rexial?
description: Select all that seem involved. Unsure is a fine answer.
multiple: true
options:
- frontend (React)
- http-server (Express REST API)
- ws-server (WebSockets)
- genAI (Python / FastAPI)
- database (Prisma / PostgreSQL)
- Docker / deployment
- CI / GitHub Actions
- Not sure
validations:
required: true

- type: dropdown
id: how-running
attributes:
label: How are you running Rexial?
options:
- Docker Compose (docker-compose up)
- Locally with pnpm dev
- Deployed instance
- Other
validations:
required: true

- type: textarea
id: logs
attributes:
label: Logs or error output
description: >
Browser console, terminal output, or container logs. This is
automatically formatted as code, so no backticks needed.
render: shell

- type: input
id: environment
attributes:
label: Environment
description: OS, Node version, browser — whatever is relevant.
placeholder: "Ubuntu 24.04, Node 20.11, Chrome 130"

- type: checkboxes
id: checks
attributes:
label: Before submitting
options:
- label: I searched existing issues and this has not been reported
required: true
- label: I am not including any secrets, API keys or passwords in this report
required: true
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: true
contact_links:
- name: Looking for something to work on?
url: https://github.com/TheCodeHeist-Coder/Rexial/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
about: Browse good first issues — each one names the files it touches.
- name: Setup not working?
url: https://github.com/TheCodeHeist-Coder/Rexial/blob/main/setup.md
about: The setup guide covers Docker and non-Docker installs, including the Python AI service.
- name: How does Rexial work internally?
url: https://github.com/TheCodeHeist-Coder/Rexial/blob/main/ARCHITECTURE.md
about: Service boundaries, data model, request flows and design decisions.
- name: Reporting a security vulnerability
url: https://github.com/TheCodeHeist-Coder/Rexial/security/advisories/new
about: Please report security issues privately, not as a public issue.
76 changes: 76 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: Feature request
description: Suggest something Rexial should be able to do
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Before opening this, it is worth checking [ROADMAP.md](https://github.com/TheCodeHeist-Coder/Rexial/blob/main/ROADMAP.md)
in case the idea is already planned.

- type: textarea
id: problem
attributes:
label: What problem would this solve?
description: >
Describe the situation where today's Rexial falls short. Start from the
problem rather than the solution — it often leads somewhere better.
placeholder: |
A host running a long quiz cannot pause it. If something goes wrong in
the room, the timer keeps running and participants lose points.
validations:
required: true

- type: textarea
id: solution
attributes:
label: What would you like to see?
description: Your proposed solution, as concretely as you can describe it.
validations:
required: true

- type: dropdown
id: area
attributes:
label: Which part of Rexial would this touch?
multiple: true
options:
- frontend (React)
- http-server (Express REST API)
- ws-server (WebSockets)
- genAI (Python / FastAPI)
- database (Prisma / PostgreSQL)
- Docker / deployment
- Documentation
- Not sure
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives you considered
description: Other approaches, or how you work around this today.

- type: dropdown
id: contributing
attributes:
label: Would you like to build this?
description: >
Entirely optional — a good idea is valuable whether or not you
implement it. Saying yes just means we will scope it with you first.
options:
- "Yes, I would like to work on it"
- "Yes, but I would need guidance"
- "No, just suggesting the idea"
validations:
required: true

- type: checkboxes
id: checks
attributes:
label: Before submitting
options:
- label: I searched existing issues and the roadmap for this idea
required: true
53 changes: 53 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
## What does this PR do?

<!-- A short description of the change. If it is a UI change, a screenshot or
short clip is worth more than a paragraph. -->

## Related issue

<!-- "Closes #12" links the issue and closes it automatically when this merges.
If there is no issue, say briefly why the change is needed. -->

Closes #

## Type of change

- [ ] Bug fix
- [ ] New feature
- [ ] Documentation
- [ ] Refactoring
- [ ] Performance
- [ ] Tests
- [ ] Build / CI / deployment

## Which services does this touch?

- [ ] `apps/frontend`
- [ ] `apps/http-server`
- [ ] `apps/ws-server`
- [ ] `apps/genAI`
- [ ] `packages/db` (schema or Prisma changes)
- [ ] Docker / CI

## How did you test this?

<!-- Tell us what you actually ran and what you saw. For a live-quiz change,
say whether you tested with more than one participant. -->

## Checklist

- [ ] I ran `pnpm run lint`
- [ ] I ran `pnpm run check-types`
- [ ] I ran `pnpm run build`
- [ ] The app still starts with `docker-compose up`
- [ ] I updated documentation if this changes behaviour or setup
- [ ] I did not commit any `.env` file, API key or other secret

<!-- If a schema changed: include the migration, and say whether it needs
any manual step on an existing database. -->

---

First pull request here? [CONTRIBUTING.md](../CONTRIBUTING.md) walks through the
whole process, and a checkbox left unticked is not a problem — say so and we
will help.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,6 @@ yarn-error.log*
# Misc
.DS_Store
*.pem

# Local scratch: issue bodies to paste into GitHub
ISSUES-TO-CREATE.local.md
123 changes: 123 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility, apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

Rexial is a project where many contributors are making their first-ever open
source contribution. Dismissing or mocking a beginner's question falls under
unacceptable behavior. If you know the answer, explain it or point to the docs.

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces — the repository,
issues, pull requests, discussions — and also applies when an individual is
officially representing the community in public spaces.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement by opening a
[private security advisory](https://github.com/TheCodeHeist-Coder/Rexial/security/advisories/new)
or by contacting a maintainer directly.

All complaints will be reviewed and investigated promptly and fairly. All
community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. Violating
these terms may lead to a temporary or permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. Violating
these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

[homepage]: https://www.contributor-covenant.org
[Mozilla CoC]: https://github.com/mozilla/diversity
6 changes: 3 additions & 3 deletions contribution.md → CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ Welcome! This guide will help you make your first contribution to the project.
## 2. Clone Your Fork

```bash
git clone https://github.com/<your-username>/<repo-name>.git
cd <repo-name>
git clone https://github.com/<your-username>/Rexial.git
cd Rexial
```

## 3. Add Upstream Remote
*This lets you sync with the original repository:-
```bash
git remote add upstream https://github.com/<original-owner>/<repo-name>.git
git remote add upstream https://github.com/TheCodeHeist-Coder/Rexial.git
git remote -v
```

Expand Down
Loading
Loading