Skip to content
Documentation on goals of the coq-community organization, the shared contributing guide and code of conduct.
HTML Nix
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
templates
.gitignore Initial commit. Draft README and CONTRIBUTING. Jun 13, 2018
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE.md
README.md
logo.svg Add the logo and a note about its origin. Jul 6, 2018

README.md

Contributing Code of Conduct Gitter

coq-community

A project for a collaborative, community-driven effort for the long-term maintenance and advertisement of Coq packages.

Note that this README (the manifesto) is a work in progress and is meant to be collaboratively improved. Please contribute!

Who runs this organization?

This organization is run by volunteer Coq users. Everyone is welcome (you don't need to be a very experienced Coq user to participate). Please get involved!

What are its goals?

Collaborative maintenance of Coq packages and tools

Projects can be hosted in coq-community in one of the following case:

  • the initial author has stopped maintaining the project and someone else is volunteering to do so;
  • the project has become a collective work (several community members are actively working on it);
  • the initial author is still maintaining the project but they want to encourage other community members to participate in the maintenance and possibly take over (and the project is indeed raising interest from the community);
  • the project is a tool of general interest and it makes sense to develop it collaboratively.

Each project under the umbrella of coq-community has one or several official maintainer(s) but the maintenance effort is done collaboratively. Users need not be afraid of volunteering to be the official maintainer of a coq-community project because they can step down at anytime. Changing the maintainer of a coq-community project can be done very easily without the hassle of moving its location too.

Maintenance is allowed to go much further than just updating the package to keep it compiling with newer Coq versions. It can also include refactorization of the code, uniformization of the style, merging with other packages, taking pieces out to put them in other libraries, and even removal of some parts that are not raising sufficient interest. These changes must, nonetheless, always be done with consideration for compatibility as soon as the package is a library, plugin or tool that has users.

Collaborative writing of documentation

Some Coq proofs present a particular pedagogical interest because their statements are easy to understand, but they require some non-trivial mathematical tools and their mechanization illustrates interesting proof patterns, or demonstrate the use of specific libraries. They could be used as the basis for tutorials which explain the tricks and interesting parts. Gathering such packages and their documentation could give rise to a new, interactive “book” that would target advanced Coq learners.

We will propose a format for the documentation packages based on a preliminary work by Pierre Castéran.

Advertising interesting packages

Not all the packages that will be taken over will be of the same initial quality. While this should not stop packages from being taken over, and new maintainers should strive to improve the package quality, some editorial work will be also required to put forward the most interesting packages, be it for their usefulness as a library or plugin, because they demonstrate interesting proof techniques, or because they represent an important achievement.

This work will be done by an editorial board which will be constituted of experimented users and prominent members of the Coq community. They will have to decide what packages to put forward and on what criteria to take these decisions. The editorial board will also oversee the collaborative writing of documentation.

If you are interested in joining this board, please let us know at theo@irif.fr and pierre.casteran@labri.fr.

FAQ

  • What is the difference with coq-contribs?

    Coq's contribs represent the legacy distribution, compatibility testing and maintenance model. There used to be a form allowing users to submit a package that the Coq development team would then maintain. While distribution now happens through the Coq package index and compatibility testing using Coq's CI, maintenance of legacy contribs is still ensured.

    coq-community is a proposed replacement for the long-term maintenance of Coq packages. Whereas contribs were maintained by the Coq development team, coq-community will be managed by the user community. We encourage users to “adopt” a package (including a legacy contrib) and to push the meaning of “maintenance” further than simply ensuring that the package continues to compile with newer Coq versions.

  • What is the relation with the Coq package index?

    The Coq package index is the present opam-based way of distributing Coq packages. As such, all packages of coq-community are meant to be listed in the Coq package index.

  • Can I propose a project of which I am the author?

    Yes, you can propose a project of which you are the author, as a way of preparing to pass on the maintenance to other community members. You can start up by proposing yourself as the primary maintainer for this project; but if you become less available for this task, we'll be able to pass on this role to someone else.

  • Do the projects of coq-community need to have some Continous Integration (CI) setup?

    Yes, CI plays a big role in keeping code projects more stable over time. In the case of a Coq package, it helps to ensure that the project stays compatible with the various versions of Coq that are claimed to be supported (as well as various versions of OCaml in the case of a Coq plugin).

    Two alternative ways of setting up CI are documented in https://github.com/coq-community/manifesto/wiki/Continuous-Integration-with-Nix and in https://github.com/coq-community/docker-coq/wiki/CI-setup. Feel free to use whichever you prefer (the proposed setup in templates/ uses a combination of both).

  • Which versions of Coq must be supported by projects of coq-community?

    At least the last stable version of Coq must be supported at any given time. Support for older versions or the development version of Coq can be decided project by project. Note that supporting the development version of Coq is a requirement to get into Coq's CI, which can be interesting to get patches from Coq developers when they introduce a breaking change (this is particularly recommended for plugins).

  • How to remove a package?

    When a package loses its interest because a newer, better alternative has been found, or for some other reason, the package can be marked as deprecated and stop being maintained. We will generally archive the repository rather than removing it completely though.

  • What kind of permissions do the members have?

    Members of the coq-community organization have write-access to all the repositories. This permission should be used wisely: only minor fixes should be pushed without going through pull requests, and pull requests should preferably be approved by the project maintainer before getting merged. Some maintainers may decide to protect branches to enforce that all changes go through pull requests and validate some conditions. Maintainers are given admin-access on the repositories that they maintain. All members have the permission to create or transfer new repositories, but they should only do so after going through the standard process. At all times, there should be exactly three (active) owners of the organization. The current owners are Karl Palmskog (@palmskog), Anton Trunov (anton-trunov), and Théo Zimmermann (@Zimmi48).

  • What to do in case of conflicts?

    We will have a governance process to make sure that we can handle conflicts that are bound to arise about the management of specific projects. Please contribute to meta-issue #2 which is about this.

  • Why this name?

    The coq-community organization takes its inspiration from the similar-named elm-community. Here are some other sister organizations:

  • Who made this awesome logo?

    This logo was designed by Aras from the openlogos project and was attributed to coq-community following a general mobilization of Coq users. Thanks to Aras and to the 94 people who voted for us to get this logo!

Is anything still unclear? Please open an issue or go to our Gitter room to ask a question.

You can’t perform that action at this time.