Skip to content

Rename DOJO.md to AGENTS.md and ignore local build artifacts #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
un33k merged 2 commits into from
Sep 27, 2026
Merged

Rename DOJO.md to AGENTS.md and ignore local build artifacts #202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a088c2
Rename DOJO.md to AGENTS.md and ignore dist_release
un33k Sep 27, 2026
bc502ec
Ignore local type-check and test caches
un33k Sep 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ env/
build/
develop-eggs/
dist/
dist_release/
downloads/
eggs/
.eggs/
Expand Down Expand Up @@ -42,6 +43,8 @@ htmlcov/
.coverage
.coverage.*
.cache
.mypy_cache/
.pytest_cache/
nosetests.xml
coverage.xml
*,cover
Expand Down
11 changes: 8 additions & 3 deletions DOJO.md → AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# DOJO.md
# AGENTS.md

The source repository is `python-slugify/`. This is the single, top-level guidance file; there is no per-repo `DOJO.md` inside `python-slugify/`.
This is the single, top-level agent guidance file for this repository.

## Workflow

- Default upstream branch is `master`. Never commit or push directly to it: all changes land via pull request to `master`, including release/version-bump commits.
- Publishing, pushing, PR creation/closure, merges and tags require applicable explicit user authorization.

## Compatibility comes first

Expand All @@ -27,7 +32,7 @@ The source repository is `python-slugify/`. This is the single, top-level guidan
- Run the unchanged legacy suite, separate release/differential checks, supported interpreter/backend tox matrix, typing/style checks, and wheel/sdist artifact validation before releases. Record actual platform and dependency coverage; never infer untested results.
- Use `tools/check_dist.py` for isolated build/artifact checks. Use build/Twine, not a `setup.py publish` shortcut.
- User prefers plain release versions (for example `9.0.0`), not an unsolicited `.dev0` suffix. A version string is not evidence of publication.
- Publishing, pushing, PR creation/closure, merges and tags require applicable explicit user authorization. Publishing to PyPI does not authorize a GitHub release or tag.
- Publishing, pushing, PR creation/closure, merges and tags require applicable explicit user authorization. Publishing to PyPI does not authorize a GitHub release or tag. A user authorization to push a branch is not authorization to merge it.
- Never put tokens in source, logs, chat or command arguments. Use securely configured credentials only with the authorized official destination. Do not record credential backup paths here.
- Verify published artifact hashes against validated local builds. After publication, update current README/install/migration guidance; preserve historical verification notes as dated evidence.

Expand Down
Loading