andrewmusselman opened a new pull request, #577:
URL: https://github.com/apache/tooling-trusted-releases/pull/577
## Pull request summary <!-- markdownlint-disable-line MD041 -->
This PR improves documentation for external contributors, addressing issue
#486.
## Changes
**DEVELOPMENT.md**
Added explanation of why ATR development is limited to Linux/macOS (POSIX
shell scripts, Docker volume behavior, platform-specific tools).
**atr/docs/running-and-creating-tests.md**
- Added "Running unit tests" subsection documenting `sh tests/run-unit.sh`
- Added "Creating end-to-end tests" section documenting:
- Test structure in `tests/e2e/`
- How to write pytest fixtures with different scopes
- Helper functions in `tests/e2e/helpers.py`
- How to write tests using Playwright's `expect`
- How to add a new test area
**CONTRIBUTING.md**
- Updated fork and clone step to include `git remote add upstream` and `git
config pull.rebase true` with explanation
- Updated PR workflow to require running all tests locally (`make check`,
`sh tests/run-e2e.sh`, `sh tests/run-unit.sh`)
- Added explicit rebase step before pushing
- Emphasized opening PRs as Draft until all checks pass
- Referenced PR template and its required acknowledgements
- Added warning that PRs failing to demonstrate proper testing may be closed
- Updated "Running tests" section to include unit tests and clarify which
are required
---
## Required acknowledgements
Please replace each `[ ]` with `[x]` to confirm.
PRs missing confirmations may be closed or converted to Draft.
* [x] I have read and followed **CONTRIBUTING.md**
* [x] I have read **DEVELOPMENT.md**
* [x] I have run the required tests and checks locally
* [x] All required checks are currently passing
* [x] This branch is **rebased on the current `main` branch**
---
---
## Rebase confirmation details (optional but encouraged)
```
$ git fetch upstream
remote: Enumerating objects: 24, done.
remote: Counting objects: 100% (24/24), done.
remote: Compressing objects: 100% (4/4), done.
remote: Total 24 (delta 20), reused 24 (delta 20), pack-reused 0 (from 0)
Unpacking objects: 100% (24/24), 2.59 KiB | 30.00 KiB/s, done.
From github.com:apache/tooling-trusted-releases
* [new branch] storage-interface-error-messages ->
upstream/storage-interface-error-messages
$ git rebase upstream/main
Current branch improve-documentation-486 is up to date.
```
---
## Additional notes
Notes at
https://github.com/apache/tooling-trusted-releases/issues/486#issuecomment-3782123815
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
