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

Proposed text for 'Guidance for closing issues' #137

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Proposed text for 'Guidance for closing issues' #137

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2598420
Proposed text for 'Guidance for closing issues'
Kevsy May 16, 2024
81d873f
Update CONTRIBUTING.md
Kevsy Jun 4, 2024
efb1f84
Update CONTRIBUTING.md
Kevsy Jun 4, 2024
8e14fa4
Update CONTRIBUTING.md
Kevsy Jun 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,16 @@ If you have questions about one of the issues, please comment on them, and one o

Please provide as much context as possible when you open an issue. The information you provide must be comprehensive enough to reproduce that issue for the assignee. Therefore, contributors may use but aren't restricted to the issue template provided by the project maintainers.

### Guidance for closing issues
* As per the [ProjectCharter](https://github.com/camaraproject/Governance/blob/5fc802713d71a51da64136f692b16ed620eeffa5/ProjectCharter.md), The default decision making mechanism for the CAMARA Project is [lazy consensus](https://couchdb.apache.org/bylaws.html#lazy). This means that any decision on technical issues is considered supported by the team as long as nobody objects based on substantiated technical grounds.
* Once consensus is achieved, an issue may be closed by the original author or by a maintainer in the sub-project.
Kevsy marked this conversation as resolved.
Show resolved Hide resolved
* Closing an issue should include a comment on how it was resolved, or reference to consensus that the issue can not be resolved.
Kevsy marked this conversation as resolved.
Show resolved Hide resolved
* Issues that are considered stale/inactive may be closed, but must include a reference to minutes where it has been agreed to be a stale issue.
Copy link
Collaborator

@hdamker hdamker May 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Again, I don't think that especially stale/inactive issues need or even can always include a reference to an explicit decision. Sometimes Maintainers just have to clean up. Propose to omit the line as covered by the previous one.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, the previous line can cover this ('closing because no update since x weeks'). Will remove this one.

* Maintainers may not close their own issues without reference to consensus achieved.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why not? If even a non-Maintainer is allowed to do that? (see line 33). Propose to omit the line.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, will omit the line, as line 33 covers it.

* A sub-project participant may object to closure of an issue if they believe consensus was not reached, in which case they may reopen the issue, stating they believe consensus has not been reached.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I suppose that just the statement "consensus has not reached" might be not enough, if there was a reason to close the issue. But I have no good idea what to require here, as it depends on the type of issue.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

'may object' is intended to allow flexibility here, depending on the type of issue.

* Closure of an issue may require closure of a Pull Request which only fixed that single (now closed) issue.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I proposed something above. BTW: one PR can close several issues, as we have seen with camaraproject/IdentityAndConsentManagement#121 which closed about a dozen issues.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed and committed

Copy link
Collaborator

Choose a reason for hiding this comment

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

@Kevsy I can see that you have committed my proposal on line 34. But here I meant the proposal for line 33 and then to delete 38. Beyond that ... what about my other change proposals?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Working on them between meetings :) Will have it all done end of day



## Contributing Code

You are welcome to contribute code in order to fix a bug or to implement a new feature.
Expand Down