Skip to content
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

Jump to bottom

docs: create Issue and Pull Request markdown doc, explaining automatic locking policy #32405

Closed
wants to merge 1 commit into from
Closed

docs: create Issue and Pull Request markdown doc, explaining automatic locking policy #32405

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/GITHUB_PROCESS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<a name="conversation-locking"></a>
# Automatic conversation locking
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the plan is for this document to expand in the future and contain more sections (on things other than converstation locking), then I assume we would link to specific section (not the file as a whole):

[converstation locking](https://github.com/.../docs/GITHUB_PROCESS.md#automatic-conversation-locking)

GitHub will automatically create anchors for headings, based on the heading text. This is hanydy, but it means that the comment template needs to be updated every time we tweak the heading.

If linking to specific section is indeed the intention, a better alternative is to use explicit anchor (which are independent of the heading text); e.g.:

<a name="conversation-locking"></a>
# Automatic conversation locking

This way, we can link to ...GITHUB_PROCESS.md#conversation-locking and the link will still work if the heading text modified later.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we would be linking to the specific section. Though we shouldn't have to change the heading title, or at least not too often.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the anchor

Closed issues and pull requests are locked automatically after 30 days of inactivity.

## I want to comment on a locked conversation, what should I do?
When an issue has been closed and inactive for over 30 days, the original context is likely outdated.
If you encounter a similar or related issue in the current version, please open a new issue and
provide up-to-date reproduction instructions.

## Why lock conversations?
Automatically locking closed, inactive issues guides people towards filing new issues with updated
context rather than commenting on a "resolved" issue that contains out-of-date or unrelated
information. As an example, someone may comment "I'm still having this issue", but without
providing any of the additional information the team needs to investigate.