chore(WI-000792): Expand README.md in wiki#17
Open
Talleyrand333 wants to merge 2 commits into
Open
Conversation
Add comprehensive sections to README: - Testing: How to run tests with examples - CI/CD: Information about GitHub Actions - Support: Where to get help Task: WI-000792
There was a problem hiding this comment.
Pull request overview
This PR updates the repository documentation to align developer tooling guidance with the stated goal of supporting Frappe v15, by adding sections describing how to run tests and what CI/CD tooling is expected.
Changes:
- Added a Testing section describing how to run Frappe tests (including coverage).
- Added a CI/CD section listing expected GitHub Actions workflows and coverage reporting expectations.
- Added a Support section with links for issues, developer documentation, and community support.
Comments suppressed due to low confidence (2)
README.md:74
- The CI/CD section references workflows (
test-on-pr.yml,linters.yml) and Codecov/coverage-threshold behavior, but the repo currently only has.github/workflows/deploy-staging.ymlanddeploy-test-production.ymland no Codecov config. Please either update these bullets to the actual workflow files/tooling in this repo or add the missing workflows/config so the README stays accurate.
GitHub Actions workflows:
- `test-on-pr.yml` - Runs tests on every PR with coverage reporting
- `linters.yml` - Code quality checks (Semgrep, pip-audit, pre-commit)
- Coverage threshold: 30%
- Codecov integration for coverage reports
README.md:80
AGENTS.mdis referenced here as the developer guide, but that file does not exist in the repository. Please add it or link to the correct existing developer documentation file/path.
- GitHub Issues: Report bugs and feature requests
- Documentation: See AGENTS.md for developer guide
- Frappe Forum: General Frappe/ERPNext questions
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+61
to
+62
| # Run specific test file | ||
| bench --site sitename run-tests --doctype Wiki Page |
Talleyrand333
changed the title
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.
Developer tooling alignment for Frappe v15.
Task: WI-000792