Conversation
There was a problem hiding this comment.
Pull request overview
Updates project documentation to improve contributor onboarding and deployment discoverability (Issue #1810).
Changes:
- Fix/normalize links and minor wording in the root README, including a pointer to
DEPLOYMENT.md. - Clarify verification steps and add cross-links in
DEPLOYMENT.md. - Expand
CONTRIBUTING.mdwith onboarding links, issue/PR guidelines, and local check commands.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
README.md |
Fixes backend README link, corrects a typo, and links to DEPLOYMENT.md. |
DEPLOYMENT.md |
Improves local verification instructions and adds related documentation links. |
CONTRIBUTING.md |
Adds onboarding + contribution guidance and expands conventions/checklists. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
CONTRIBUTING.md
Outdated
| - See [backend/README.md](backend/README.md) for environment and commands | ||
| - Run linting and type checks: `poetry run ruff check` and `poetry run mypy` | ||
| - Run tests: `poetry run pytest` | ||
| - Apply formatting before committing; the `backend/pre-commit` and `backend/pre-push` hooks can help automate this — see [backend/README.md](backend/README.md) for installation instructions |
dede999
force-pushed
the
docs/improve-contributing-docs
branch
from
b8a9777 to
0f384d3
Compare
CONTRIBUTING.md
Outdated
| ### Guidelines for PRs to create | ||
|
|
||
| A good PR includes: | ||
| - A title that follows the Conventional Commits format (e.g., `fix(backend): correct pagination offset`) |
There was a problem hiding this comment.
Nice suggestion. I'll add it
CONTRIBUTING.md
Outdated
| - Wait for someone to approve the execution of Github Actions. Ensure CI is green before requesting reviews | ||
| - Wait for someone to approve the execution of GitHub Actions. Ensure CI is green before requesting reviews | ||
| - At least one approval is required before merging | ||
| - Merge via the command line (fetch + merge), not the GitHub merge button |
There was a problem hiding this comment.
include some emphasis here, using bold or caps.
CONTRIBUTING.md
Outdated
There was a problem hiding this comment.
same. We can include a link on Issues.
CONTRIBUTING.md
Outdated
There was a problem hiding this comment.
I believe it is better to hide the links like
CONTRIBUTING.md
Outdated
There was a problem hiding this comment.
I believe it is better to hide the links like
There was a problem hiding this comment.
I guess this suggestion is duplicated
dede999
force-pushed
the
docs/improve-contributing-docs
branch
from
0f384d3 to
4fcf1f0
Compare
CONTRIBUTING.md
Outdated
| - A title that follows the Conventional Commits format (e.g., `fix(backend): correct pagination offset`) | ||
| - [there is a section mentioning that beyond](#conventional-commits) |
There was a problem hiding this comment.
| - A title that follows the Conventional Commits format (e.g., `fix(backend): correct pagination offset`) | |
| - [there is a section mentioning that beyond](#conventional-commits) | |
| - A title that follows the [Conventional Commits](#conventional-commits) format (e.g.: `fix(backend): correct pagination offset`) |
dede999
force-pushed
the
docs/improve-contributing-docs
branch
from
8bf5362 to
81ff4b8
Compare
CONTRIBUTING.md
Outdated
| - At least one approval is required before merging | ||
| - **<ins>Merge via the command line (fetch + merge),</ins>** not the GitHub merge button |
There was a problem hiding this comment.
At least one approval is required before merging
Currently the "required approvals" is manual, not enforced by the repository, so I'd remove this
Merge via the command line (fetch + merge), not the GitHub merge button
This is also not really a recommendation, because since we have branch protection on main the GitHub button does the right action of squash and merge. If we didn't have the branch protection we would recommend rebase and merge from the command line, but you can remove this line for now.
dede999
force-pushed
the
docs/improve-contributing-docs
branch
from
81ff4b8 to
33fe18e
Compare
Description
This are just some additions to the documentation on how to contribute to this project
How to test
There are no tests to be made
Related issues