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

Add editorial board #353

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

Add editorial board #353

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbabbf7
Adds mentions to an editorial board, with the names of its members
ybertot Jul 18, 2023
f86ddb1
cosmetics
ybertot Jul 18, 2023
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
8 changes: 7 additions & 1 deletion charter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,18 +40,24 @@ Here are the different categories of expected stakeholders for the Coq Platform:

- Packages are typically included on user request via a github issue.

- Requests should contain a justification. Good justifications are usage of the package in a regular course or a course with more than 25 attendees or usage of the package as prerequisite in at least three other packages or research developments by authors other than the author of the original package.
- Requests should contain a justification. Example justifications are usage of the package in a regular course or a course with a large audience or usage of the package as prerequisite in at least three other packages or research developments by authors other than the author of the original package.
Copy link
Collaborator

@palmskog palmskog Jul 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I've always felt that if enforced harshly, this paragraph (both before and after the current change) has the potential to lead to "chicken and egg" problems, where researchers feel packages need to be in the Platform before they use them, but packages need to have serious research users to become included.

How about mentioning explicitly something about the possibility of exceptions for packages that fill a specific important niche? One example would be the (already included) LibHyps package.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Indeed "filling an important niche" is also a valid justification and one could add this as example.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will do it, but in another branch, to avoid triggering CI at each minute change in this documentation page.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

see https://github.com/ybertot/platform/tree/add-editorial-board-silent

Copy link
Collaborator

Choose a reason for hiding this comment

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

@ybertot : I plan to implement the suggestion by Andew in Zulip. In the mean time I will cancel the runs manually (I anyway tend to do this, but I was on vacation yesterday).


- The author(s) or current maintainer(s) of the package shall agree to the inclusion of their package in the Coq Platform. This means that they agree to put reasonable effort into releasing a version of the package compatible with each new Coq release shortly after every Coq release and to maintain some relative stability between each release. The agreement of the authors is given via a comment in the respective github issue.

- All the dependencies of a platform package are also officially part of the platform. This means in particular that, apart from dependencies that are outside the Coq ecosystem and are well-known to be stable and well supported, the maintainers of the dependencies should also agree to the inclusion in the platform and commit to keep producing new compatible releases which are relatively stable. As part of the stability commitment, maintainers should refrain from adding new dependencies that are not already part of the platform without raising the question with the platform maintainers.

- Requests for inclusion shall be reviewed by a **Platform Editorial Board** to help the curator decide on the matter.

## Package exclusion process

- The exclusion of a package shall be a rare event.

- In case the package authors / maintainers cannot maintain compatibility to a new Coq release in the expected time, for one release the curator will try to organize maintenance otherwise. The platform curator will also have timely discussions with the Coq team in case changes in core Coq might lead to substantial maintenance effort in a platform package. If the maintenance problem continues for the next release, the curator can remove a package from the platform. The platform users shall be informed about such a decision as early as possible, at least 1 month before a platform release.

## Platform editorial board

The mission of the platform editorial board is to help the curator making informed decisions about the packages that should be included in the Coq platform. Membership in this editorial board is the result of co-optation, with representatives of the core development team, the curator, and representative users.

## Questions to be resolved

### Quality constraints for included packages
Expand Down
Loading