ci: add Ruff config, expand README, fix commitlint, remove setup.py#20
Open
Talleyrand333 wants to merge 1 commit into
Open
ci: add Ruff config, expand README, fix commitlint, remove setup.py#20Talleyrand333 wants to merge 1 commit into
Talleyrand333 wants to merge 1 commit into
Conversation
- Replace legacy black+isort with Frappe-aligned Ruff config in pyproject.toml - Expand README.md from 1.9KB to 5.9KB (architecture, DocTypes, contributing) - Add deprecate type to commitlint.config.js (Frappe upstream alignment) - Remove legacy setup.py (all metadata already in pyproject.toml)
There was a problem hiding this comment.
Pull request overview
This PR updates project tooling and documentation by migrating Python lint/format configuration to Ruff, expanding the README with setup and contributor guidance, aligning commitlint types with upstream, and removing the legacy setup.py in favor of pyproject.toml.
Changes:
- Replace Black/isort tool config with Ruff lint + format configuration in
pyproject.toml. - Expand
README.mdwith prerequisites, architecture overview, testing, and contribution workflow. - Add the missing
deprecatecommit type tocommitlint.config.jsand removesetup.py.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
pyproject.toml |
Removes Black/isort config and adds Ruff lint/format configuration. |
README.md |
Adds detailed project documentation (prereqs, architecture, testing, contributing). |
commitlint.config.js |
Extends allowed conventional commit types with deprecate. |
setup.py |
Removes legacy setuptools packaging entrypoint (metadata now in pyproject.toml). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```bash | ||
| # get app | ||
| $ bench get-app https://github.com/frappe/wiki | ||
| bench get-app https://github.com/ONE-F-M/wiki.git --branch staging |
| ### 1. Fork & Clone | ||
|
|
||
| ```bash | ||
| git clone https://github.com/ONE-F-M/wiki.git |
| ``` | ||
| Note: Wiki's master branch does not support v13 Frappe / ERPNext | ||
|
|
||
| > **Note:** Wiki's master branch does not support v13 Frappe / ERPNext. |
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.
Summary
Closes remaining gaps from Work Item (10) DEVOPS-004 sprint:
Changes
pyproject.toml[tool.black]+[tool.isort], added Frappe-aligned[tool.ruff],[tool.ruff.lint],[tool.ruff.format]README.mdcommitlint.config.jsdeprecatetype to match Frappe upstream (11 → 12 types)setup.pypyproject.toml([project]section with name, description, authors, dependencies)Work Items Addressed
Testing
linters.ymlworkflow will validate Ruff config on this PR