mirror of
https://github.com/vitorpamplona/amethyst.git
synced 2026-08-09 08:04:45 +00:00
docs(contributing): scope proof-of-testing to non-regular contributors
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
<!--
|
||||
Thanks for contributing to Amethyst! Before opening this PR, please skim
|
||||
CONTRIBUTING.md — especially the "Proof of testing" and "Interoperability
|
||||
tests" sections if this is your first PR.
|
||||
tests" sections if you are not a regular contributor to this repo.
|
||||
|
||||
Delete any section below that doesn't apply.
|
||||
-->
|
||||
@@ -20,8 +20,9 @@ For UI changes, attach screenshots (light + dark) or a short recording.
|
||||
For Android: device model + Android version. For Desktop: OS + window size.
|
||||
For build/packaging changes: paste the `./gradlew` command + tail of output.
|
||||
|
||||
If this is your FIRST PR to this repo, this section is required regardless
|
||||
of how small the change is — see CONTRIBUTING.md § Proof of testing. -->
|
||||
If you are NOT a regular contributor to this repo, this section is required
|
||||
regardless of how small the change is — see CONTRIBUTING.md § Proof of
|
||||
testing. -->
|
||||
|
||||
- [ ] Ran `./gradlew spotlessApply` — repo is formatted
|
||||
- [ ] Ran `./gradlew test` (or the relevant module's tests)
|
||||
|
||||
+12
-10
@@ -11,7 +11,7 @@ license header with the original author(s) and source.
|
||||
|
||||
- [Ways to contribute](#ways-to-contribute)
|
||||
- [Human and AI contributions](#human-and-ai-contributions)
|
||||
- [New contributor: proof of testing](#new-contributor-proof-of-testing)
|
||||
- [New / occasional contributor: proof of testing](#new--occasional-contributor-proof-of-testing)
|
||||
- [Reporting bugs and requesting features](#reporting-bugs-and-requesting-features)
|
||||
- [Security issues](#security-issues)
|
||||
- [Development setup](#development-setup)
|
||||
@@ -64,11 +64,13 @@ The rules are the same in both cases:
|
||||
- **No machine-translated locale files.** Translations go through Crowdin so
|
||||
native speakers can review them.
|
||||
|
||||
## New contributor: proof of testing
|
||||
## New / occasional contributor: proof of testing
|
||||
|
||||
If this is your **first PR** to this repository, the PR description must
|
||||
include proof that you actually ran the change. This applies whether the
|
||||
patch was written by you or by an AI assistant.
|
||||
If you are **not a regular contributor** to this repository — that is, this
|
||||
is one of your first PRs, or you've only contributed sporadically and the
|
||||
current maintainers wouldn't recognize your handle from recent history — the
|
||||
PR description must include proof that you actually ran the change. This
|
||||
applies whether the patch was written by you or by an AI assistant.
|
||||
|
||||
What "proof" means:
|
||||
|
||||
@@ -89,10 +91,10 @@ What "proof" means:
|
||||
- **Translation-only PRs:** screenshots are not required, but mention which
|
||||
locale and which strings you touched.
|
||||
|
||||
You don't need to keep doing this on every subsequent PR — once we've seen
|
||||
that you can run the project end-to-end, a short test plan in the PR
|
||||
description is enough. Maintainers may still ask for screenshots on visual
|
||||
changes regardless of contributor seniority.
|
||||
Once you have an established track record in the repository, a short test
|
||||
plan in the PR description is enough on subsequent PRs. Maintainers may
|
||||
still ask for screenshots on visual changes regardless of contributor
|
||||
seniority.
|
||||
|
||||
If you cannot run a particular target locally (e.g. you don't have macOS but
|
||||
your change affects the DMG build), say so explicitly in the PR — don't
|
||||
@@ -370,7 +372,7 @@ A good PR description has:
|
||||
`cli`, etc.
|
||||
3. **Test plan** — exactly what you ran, on what platform, with what
|
||||
result. Include screenshots / recordings for UI changes (mandatory for
|
||||
first-time contributors; expected for all contributors on visual
|
||||
non-regular contributors; expected for all contributors on visual
|
||||
changes).
|
||||
4. **Risk / rollback** — if the change touches relay subscriptions, the
|
||||
`NostrClient`, signing, or anything in `Account`/`LocalCache`, call out
|
||||
|
||||
@@ -441,8 +441,8 @@ to `onPause` methods.
|
||||
## Contributing
|
||||
|
||||
See **[CONTRIBUTING.md](CONTRIBUTING.md)** for the full guide — workflow,
|
||||
coding standards, the proof-of-testing rule for first-time contributors
|
||||
(human or AI-assisted), the cross-stack interop suites, and how the
|
||||
coding standards, the proof-of-testing rule for new / occasional
|
||||
contributors (human or AI-assisted), the cross-stack interop suites, and how the
|
||||
`[BUG]` / `[FEATURE]` issue templates and bounty system work.
|
||||
|
||||
Quick links:
|
||||
|
||||
Reference in New Issue
Block a user