Conversation
Add quick start, contributing checklist, and CI expectations to README. Rewrite contributing.rst with concrete PR steps, CI checks, and code style guidance. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This pull request significantly improves the project's documentation by making it more accessible and comprehensive. The changes restructure the main documentation index, enhance the contributing guide with clear pre-submission checklists, and update the README with quick-start instructions.
Changes:
- Reorganized
docs/source/index.rstto prioritize quick-start information, document all Make targets, and provide an overview of Django apps and Docker services - Enhanced
docs/source/contributing.rstwith a structured pre-submission checklist and detailed CI checks explanation - Updated
README.mdwith quick-start instructions and inline contributing guidelines
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/source/index.rst | Complete restructure: moved quick-start to top, added Make targets documentation, apps overview, and Docker services details |
| docs/source/contributing.rst | Added structured pre-submission checklist and CI checks section with coverage threshold details |
| README.md | Streamlined content with quick-start instructions and inline contributing guidelines instead of just links |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f10b863ad9
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| .. code-block:: bash | ||
|
|
||
| make manage test events |
There was a problem hiding this comment.
The new example make manage test events is not executable with the current Makefile behavior: make treats test and events as separate goals, so this invocation triggers manage, then runs the full test target, and finally fails with No rule to make target 'events'. This means contributors following the docs cannot actually run a single app's tests as intended.
Useful? React with 👍 / 👎.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Description