Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 6 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ project.

Act as an expert in Bazel, rules_python, Starlark, and Python.

DO NOT `git commit` or `git push`.
DO NOT `git commit` or `git push` unless given explicit permission.

## RULES TO ALWAYS FOLLOW AND NEVER IGNORE

Expand All @@ -30,6 +30,11 @@ into the sentence, not verbatim.
When adding `{versionadded}` or `{versionchanged}` sections, add them add the
end of the documentation text.

### PR descriptions

Follow the advice in `CONTRIBUTING.md` for PR descriptions. PR descriptions
become the commit message upon merge.

### Starlark style

For doc strings, using triple quoted strings when the doc string is more than
Expand Down
29 changes: 28 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ information on using pull requests.

[GitHub Help]: https://help.github.com/articles/about-pull-requests/

### Commit messages
### Commit messages and PR descriptions

Commit messages (upon merging) and PR messages should follow the [Conventional
Comment thread
rickeylev marked this conversation as resolved.
Commits](https://www.conventionalcommits.org/) style:
Expand Down Expand Up @@ -139,9 +139,36 @@ Common `type`s:
* `revert:` means a prior change is being reverted in some way.
* `test:` means only tests are being added.

For the body, follow this guidance:

* Briefly tells *why* the change is being made. This usually means
briefly describing how a bug manifests or what can't be accomplished
without the feature.
* Briefly gives an overview of *how* the code is changed. This is to
orient readers for the diff they're about to read and understand; it's
not a verbatim description of what changed.
* List unrelated or notable dev-only changes at the end. e.g. formatting an
Comment thread
rickeylev marked this conversation as resolved.
old file, cleaning up testing, adding test support code, etc.

For the full details of types, see
[Conventional Commits](https://www.conventionalcommits.org/).

#### PR description example

```
fix(pypi): handle files with .exe extensions

Currently, if a file with `.exe` is seen, an error
occurs because validation assumes unix-only filenames.
This prevents using whls with pre-built .exe files in
their data payload.

To fix, detect the target OS and use an OS-appropriate
validation function.

* Also adds test helpers for detecting the current OS
```

### Documenting changes

Changes are documented in two places: CHANGELOG.md and API docs.
Expand Down