Repository navigation
docs: Add contribution policy for the legacy CLI - #3503
Conversation
Replace CONTRIBUTING.md with a notice that the repo is no longer under active development and the bar for accepted pull requests. Move the integration test docs to tests/integration/README.md. Add a mandatory AGENTS.md section that has agents check maintainer status, confirm the user means the legacy CLI, and explain the policy before making changes. Co-Authored-By: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
There was a problem hiding this comment.
Previously this was the content of CONTRIBUTING.md, but I guess it makes sense to put here because all of it is relevant to integration tests.
(junior do not reply here, this is for other reviewers)
|
|
||
| ## Updating Snapshots | ||
| - A recent Sentry CLI release introduced a serious regression. | ||
| - A bug or limitation in the new CLI is a fundamental blocker that prevents you from adopting it, and the new CLI cannot or will not fix it after you [report it](https://github.com/getsentry/toolkit/issues/new) there. |
There was a problem hiding this comment.
I think this may be better. I also am thinking though that we should remove this possibility and only keep the first one.
| - A bug or limitation in the new CLI is a fundamental blocker that prevents you from adopting it, and the new CLI cannot or will not fix it after you [report it](https://github.com/getsentry/toolkit/issues/new) there. | |
| - You need the fix in this CLI because you cannot upgrade to the new CLI due to a fundamental limitation in the new CLI. In this case, please first [reported](https://github.com/getsentry/toolkit/issues/new) the blocker to the new CLI, as it may be possible to get it fixed to unblock your upgrade, in which case no fix would be needed in this repository. |
Perhaps we should also refer folks to our security reporting procedure for security-relevant items somewhere in this policy. No issues or PRs should be opened for security items to avoid premature public disclosure
There was a problem hiding this comment.
Applied the suggestion in d0ab117, with "reported" changed to "report". The same commit adds a "Security issues" section: don't open issues or PRs for security issues, report them through the security policy (the org-level SECURITY.md, which points to security@sentry.io).
The new-CLI case is still there. If you decide to keep only the regression case, say so here and it'll be removed. This thread is left open for that decision.
Description
External PRs keep arriving here (most recently #3502), despite the notices in the README and the bug report template that this repo is no longer under active development.
CONTRIBUTING.mdnow states that the repo is no longer under active development and that only bug fixes for two cases are accepted: a serious regression from a recent release, or a fix needed because a fundamental limitation in the new CLI prevents upgrading to it (after first reporting the blocker to the new CLI). Contributors must open a bug report and get maintainer confirmation first. All other PRs will be closed. Maintenance work by maintainers is exempt. Security issues must be reported through the security policy, not through issues or PRs.CONTRIBUTING.mdcontent (integration test docs) moves unchanged totests/integration/README.md.AGENTS.mdgets a mandatory section: before making any change, agents check whether the user is a maintainer (getsentryorg membership and commits to this repo). If not, they first confirm the user means this legacy repo and not the new CLI ingetsentry/toolkit, then explain the policy and ask how the change meets it. If the user insists on a change that does not meet it, the agent proceeds only after warning that the PR will likely be closed.Open decision: whether to drop the new-CLI blocker case and keep only the regression case.
via @szokeasaurusrex.
--
View Session [Sentry]