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.
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
docs: create Issue and Pull Request markdown doc, explaining automatic locking policy #32405
Conversation
b3b8f72
to
c19fb67
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The file name is too generic. Do we have to have a specific name for it to be picked up or is it up to us?
Also, could we move it in a subdirectory?
GITHUB_PROCESS.md
Outdated
Inactive issues and pull requests in Angular repos are automatically locked after 30 days. | ||
|
||
Issues and pull requests are locked based on the following criteria: | ||
- In a closed or merged state |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sounds confusing. Does this mean that closed/merged issues will be locked (and no more comments will be allowed)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After 30 days of no activity on the closed/merged pr, yes.
Though now that I reread this it is redundant as a merging a PR closes it, so a merged PR is closed. Updated.
GITHUB_PROCESS.md
Outdated
Automatically locking inactive issues and pull requests allows for Angular's project maintainers to prioritize and focus on active work in our projects. | ||
|
||
#### I want to comment on an issue/pull request that was locked, what should I do? | ||
When an an issue has been closed and inactive for over 30 days, the original context has likely become outdated. If you are encountering a similar or related issue in the current version, please open a new issue and provide up-to-date reproduction instructions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: an an
c19fb67
to
90a93e9
Compare
The name is intentionally generic as it will be a location where we can explain our Github Processes for pull requests and issues. As we do more to automate the lifecycle of issues/prs in our repos. The intention of having it at the base of the repo is that we will be linking to it when we auto lock issues so we want to have the "prettiest" URL possible. Additionally, it is a org wide policy so other repos from the Angular org will link to it as well. That is the idea at least. |
I think this belongs in /docs/ |
Moved, as discussed offline. |
90a93e9
to
3437d39
Compare
docs/GITHUB_PROCESS.md
Outdated
Inactive issues and pull requests in Angular repos are automatically locked after 30 days. | ||
|
||
Issues and pull requests are locked based on the following criteria: | ||
- In a closed state |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I still find this confusing 😁
My understanding is that we are going to lock all issues that have no activity for 30 days or more. If my understanding is correct, then this bullet point is redundant (since the second bullet point covers both open and closed issues) and having it here makes it sound as if we are locking closed issues immediately.
If the idea is to only lock closed issues (that additionally do not have any activity for 30 days or more), then I would make it explicit that both criteria must be met for an issue to be closed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The idea is to only lock closed issues. We do not want to automatically lock open issues.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated to be more explicit that both must be true.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would just eliminate this second bit and update the first sentence to highlight the "Closed" part. Also I accidentally edited the rest:
# Automatic conversation locking
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.
## Who do you think you are?
I'm Batman.
Okay, maybe not that last part.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could also see adding a section like
## What counts as activity?
Any comment counts as activity. Reactions do not count as activity.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated
BTW, regarding the file name and the URL pointing to the file:
Generally, getting from an old file version to the latest version is fairly easy, when the file is at the same location on master. But going from a broken link to the version of the file at the point at which the comment was posted is not that straight forward. |
Good call on linking to the file, we will need to be sure to do that. That will occur in angular/dev-infra#28 |
3437d39
to
7b7efba
Compare
@gkalpak do you a suggestion for the file naming? I think the file naming makes sense for the overall usage of the file long term, but am open to other options. |
7b7efba
to
2d525e5
Compare
cc @jelbourn to weigh in on wording of the markdown file |
2d525e5
to
134b39d
Compare
@@ -0,0 +1,13 @@ | |||
# Automatic conversation locking |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added the anchor
134b39d
to
3707f9b
Compare
I am not 100% clear on what the file is going to be used long term (and I am not good with names anyway 😛), but I could also see a name with "maintenance" and "policies", but that could get long (and "policies" makes it sound formal). |
This PR got marked as needing @IgorMinar for approval because it did not fit into any of the |
Sorry, I submitted this PR prematurely thinking it was ready, but we still need @IgorMinar to review. |
…c locking policy (angular#32405) PR Close angular#32405
…automatic locking policy (angular#32405) This reverts commit ad13520.
…c locking policy (angular#32405) PR Close angular#32405
…c locking policy (angular#32405) PR Close angular#32405
…automatic locking policy (angular#32405) This reverts commit ad13520.
…c locking policy (angular#32405) PR Close angular#32405
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
No description provided.