docs: make CONTRIBUTING match the actual project setup - #805
Merged
Irozuku merged 1 commit intoAug 10, 2026
Conversation
The development instructions were still cookiecutter boilerplate and no longer describe this project: - Step 1 pointed contributors to fork ionelmc/DashAI, which is the cookiecutter author's namespace, not this project. - Steps 4, 6 and the Tips section told contributors to run tox. There is no tox.ini and tox is not a dependency, so the command fails. - The merge checklist asked contributors to add themselves to AUTHORS.rst, which does not exist in the repository. - pre-commit, ruff and uv (all configured in the repo) were not mentioned at all. Replaces them with the commands the project actually uses. Documentation only; no code or configuration is touched.
Irozuku
self-requested a review
August 10, 2026 16:45
Irozuku
approved these changes
Aug 10, 2026
Author
|
:)
El lun, 10 ago 2026 a las 13:06, Emilio Diaz ***@***.***>)
escribió:
… Merged #805 <#805> into
develop.
—
Reply to this email directly, view it on GitHub
<#805?email_source=notifications&email_token=AUTRTRQHKGC3G5ZUYS7KHBL5JH6IDA5CNFSNUABQM5UWIORPF5TWS5BNNB2WEL2JONZXKZKFOZSW45CON52GSZTJMNQXI2LPNYXTEOJSGM3DEOBTHE2THJTSMVQXG33OUZQXK5DIN5ZKKZLWMVXHJLDGN5XXIZLSL5RWY2LDNM#event-29236283953>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AUTRTRRTXSNACARAOMH2Y7D5JH6IDAVCNFSNUABFKJSXA33TNF2G64TZHM2TEMZRGEZTMMZQHNEXG43VMU5TKMJRGE2TINJXGQ22C5QC>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
--
|
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
2 participants
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
CONTRIBUTING.rststill contains cookiecutter boilerplate that no longerdescribes this project. A contributor following the development steps in order
fails at step 4, because the command it tells them to run does not exist here.
Type of Change
Changes (by file)
CONTRIBUTING.rst: rewrote the Development, Pull Request Guidelines and Tipssections so they match the repository as it is today:
ionelmc/DashAI, the cookiecutter author'snamespace, not this project.
tox. There is notox.iniand tox is not a dependency, so the command fails.
AUTHORS.rst,which does not exist in the repository.
uv,ruffandpre-commit— all configured in the repo — were notmentioned at all.
develop.Testing
Documentation only; no code or configuration is touched.
The file was rendered with docutils at
halt_level=2(warnings treated aserrors) and produced no warnings.
Notes
The replacement commands are taken from the repository's own
CLAUDE.md, whichis up to date — so this only brings the human-facing guide in line with what is
already documented for agents.