diff --git a/CREDIT.md b/CREDIT.md index dfd9aa608b6e2deaffa29524ca38057fcb4aa21e..57547d1e0e3a6cd7e0b62766deab654787674acc 100644 --- a/CREDIT.md +++ b/CREDIT.md @@ -1,11 +1,9 @@ -The following people have contrinuted to the Pactole library. See also -the LICENSE file. - -Cédric Auger (2013) -Thibaut Balabonski (2016-2017) -Sebastien Bouchard (2021-) -Pierre Courtieu (2013-) -Robin Pelle (2016-2020) -Lionel Rieg (2014-) -Xavier Urbain (2013-) +The following people have contributed to the development of the Pactole library during the indicated periods of time: +- Cédric Auger (2013) +- Thibaut Balabonski (2016-2017) +- Sebastien Bouchard (2021- now) +- Pierre Courtieu (2013- now) +- Robin Pelle (2016-2020) +- Lionel Rieg (2014- now) +- Xavier Urbain (2013-now) diff --git a/DEV.md b/DEV.md index 9597e8b9db1f558fefbd28d14538788f8d384d46..28ee18e448cbad3ac3247bdb2557c69df600aa56 100644 --- a/DEV.md +++ b/DEV.md @@ -1,13 +1,16 @@ -# Contributing +The fundamental principle is that the MASTER branch must remain compilable at all times and should never contain incomplete developments. -The golden rule is that **MASTER SHOULD COMPILE AT ALL TIME** and does not -contain in-progress developments. +Development work on the master branch must be avoided. Instead, each feature or topic should have its own dedicated branch. Developers should create new branches as needed, and all work—including collaborative efforts—should occur within these topic-specific branches. -More precisely, development never happens on master: each topic should have -its own branch (feel free to create one if needed) and work happens there, -even when several people are involved. +Before merging changes into master, ensure that your code: -Once a set of changes (e.g. a new case study) is complete and polished enough -(comments, adequate identation, no use of generated hypothesis names, etc.), -you may merge it to master by squashing its commits into meaningful pieces -(only a few, usually one may be enough) or submit a pull request. +- Is complete and thoroughly tested +- Contains clear and comprehensive comments +- Features proper indentation +- Uses descriptive hypothesis names rather than auto-generated ones +- Meets all project quality standards + +When your changes are ready (such as a completed case study), you have two options: + +1. Submit a pull request for review +2. Merge directly into master after squashing your commits into meaningful, well-organized units (typically one or a few commits that clearly represent the changes) diff --git a/codemeta.json b/codemeta.json index de545b51aa98ebf74a62f91069fbf722824202a4..d6ace5d8e2dd34759b9a802fc172a18d720d908a 100644 --- a/codemeta.json +++ b/codemeta.json @@ -1,69 +1,57 @@ { - "@context": "https://doi.org/10.5063/schema/codemeta-2.0", - "@type": "SoftwareSourceCode", - "name": "Pactole", - "license": "https://spdx.org/licenses/LGPL-3.0", - "codeRepository": "https://gitlab.liris.cnrs.fr/pactole/coq-pactole", - "relatedLink": "TODO? https://???", - "dateCreated": "TODO 2013-??-??", - "datePublished": "TODO 2024-???", - "version": "TODO 2.0???", - "description": "TODO A Coq library formalizing the distributed computing model for robot swarm called Look-Compute-Move (due to Suzuki and Yamashita) and several case studies in this model. ", - "applicationCategory": "FIXME: Formal development", - "releaseNotes": "TODO Second release.", - "runtimePlatform": "Coq-8.20", - "developmentStatus": "active", - "funding": [ - { "@type":"Grant", - "identifier": "Digiteo Project #2009-38HD" } , - { "@type":"Grant", - "identifier": "ANR Project 2019-CE25-0005" } - ], - "keywords": [ - "distributed systems", - "formal proof", - "robot swarm" - ], - "programmingLanguage": [ - "Coq/Rocq" - ], - "runtimePlatform": [ - "Coq/Rocq" - ], + "@context": "https://w3id.org/codemeta/3.0", + "type": "SoftwareSourceCode", + "applicationCategory": "Coq library dedicated to formal verification of mobile robotic swarm distributed protocols", "author": [ { - "@type": "Person", - "@id": "https://orcid.org/0000-0001-8789-9781", - "givenName": "Pierre", - "familyName": "Courtieu", - "email": "Pierre.Courtieu@lecnam.net", + "id": "https://orcid.org/0000-0001-8789-9781", + "type": "Person", "affiliation": { - "@type": "Organization", + "type": "Organization", "name": "Conservatoire National des Arts et Métiers" - } + }, + "email": "Pierre.Courtieu@lecnam.net", + "familyName": "Courtieu", + "givenName": "Pierre" }, { - "@type": "Person", - "@id": "https://orcid.org/0000-0001-7442-2538", - "givenName": "Xavier", - "familyName": "Urbain", - "email": "Xavier.Urbain@univ-lyon1.fr", + "id": "https://orcid.org/0000-0001-7442-2538", + "type": "Person", "affiliation": { - "@type": "Organization", + "type": "Organization", "name": "Université Claude Bernard Lyon 1" - } - } + }, + "email": "Xavier.Urbain@univ-lyon1.fr", + "familyName": "Urbain", + "givenName": "Xavier" + }, { - "@type": "Person", - "givenName": "Lionel", - "familyName": "Rieg", - "email": "lionel.rieg@univ-grenoble-alpes.fr", + "id": "_:author_3", + "type": "Person", "affiliation": { - "@type": "Organization", + "type": "Organization", "name": "Verimag, Grenoble INP -- UGA" - } + }, + "email": "lionel.rieg@univ-grenoble-alpes.fr", + "familyName": "Rieg", + "givenName": "Lionel" } ], - "contributor": "TODO: Les stagiaires comme ci-dessus?", - "citation": "TODO un papier décrivant Pactole" + "codeRepository": "https://gitlab.liris.cnrs.fr/pactole/coq-pactole", + "description": "A Coq library dedicated to formally verifying distributed protocols for mobile robot swarms. The library implements various extensions of the Look-Compute-Move model, first proposed by Suzuki and Yamashita, providing a robust framework for protocol verification in different theoretical settings. ", + "keywords": [ + "distributed systems", + "deductive verification", + "formal proof", + "robotic swarms" + ], + "license": "https://spdx.org/licenses/LGPL-3.0", + "name": "Pactole", + "programmingLanguage": "Coq/Rocq", + "relatedLink": "https://pactole.liris.cnrs.fr/", + "runtimePlatform": "Coq-8.20", + "version": "2.1", + "developmentStatus": "active", + "funding": "Digiteo Project #2009-38HD, ANR Project 2019-CE25-0005", + "referencePublication": "https://doi.org/10.4230/LITES.8.2.2" }