Chore/contributingmd/initial doc#15
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Adds initial contributor documentation and links it from the README to address Issue #9.
Changes:
- Added a new root-level
CONTRIBUTING.mdcovering prerequisites, local setup, issue workflow, and PR process. - Linked the contributing guide from the “Getting Started” section in
README.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Adds a pointer to the new contributing guidelines from the setup entry point. |
| CONTRIBUTING.md | Introduces a concise contributor workflow guide (setup, tests, codegen, branch naming, PR target/expectations). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+12
to
+16
| ```bash | ||
| git clone git@github.com:TheRealDarkCoder/routis.git | ||
| cd routis | ||
| cp .env.example .env | ||
| docker compose up |
There was a problem hiding this comment.
The local setup uses an SSH clone URL only (git@github.com:...). New contributors often won’t have SSH keys configured (and many will be working from a fork), so this step can fail as-written. Consider switching to an HTTPS clone example or showing both HTTPS + SSH, and optionally mention forking before cloning for external contributors.
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Closes #9
What changed
Added a CONTRIBUTING.md file satisfying issue needs
Checklist
docker compose upworks locallyschema.dbmlupdated if schema changed