docs: make the project ready for outside contributors - #153
Merged
Merged
Conversation
Rexial was public but not actually contributable: there was no license, and the setup instructions pointed at a repository name that no longer exists, so a new contributor failed at the clone step. Licensing - Add MIT LICENSE. Without it the repository was implicitly all-rights-reserved, so nobody could legally fork or contribute. Fix the stale Qtrive naming - setup.md cloned TheCodeHeist-Coder/Qtrive, which does not resolve - Navbar linked to the same dead repository - Rename the package and dev container names to Rexial Deliberately left as Qtrive: POSTGRES_DB, DATABASE_URL and the docker volume names (renaming orphans existing local dev databases), and the 'Qtrive-auth' localStorage key (renaming logs out every current user). These are runtime state, not branding. Documentation - Rewrite README: the previous one ended mid-code-block with an unclosed fence and had no license or contributing section - Point the demo link at demo.mp4 rather than the space-containing filename - Rename contribution.md to CONTRIBUTING.md so GitHub links it automatically on every new issue and pull request - Fix the placeholder clone URLs inside it - Add ROADMAP.md, CODE_OF_CONDUCT.md and SECURITY.md Issue and PR templates - Add bug report and feature request forms with required fields, so reports arrive with reproduction steps instead of one-line summaries - config.yml links to good first issues, setup and architecture docs - Add a pull request template Verified: pnpm lint (19 pre-existing frontend errors, unchanged), check-types and build all pass; frontend tsc --noEmit is clean. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rexial was public but not actually contributable: there was no license, and the setup instructions pointed at a repository name that no longer exists, so a new contributor failed at the clone step.
Licensing
Fix the stale Qtrive naming
Deliberately left as Qtrive: POSTGRES_DB, DATABASE_URL and the docker volume names (renaming orphans existing local dev databases), and the 'Qtrive-auth' localStorage key (renaming logs out every current user). These are runtime state, not branding.
Documentation
Issue and PR templates
Verified: pnpm lint (19 pre-existing frontend errors, unchanged), check-types and build all pass; frontend tsc --noEmit is clean.