coq / platform-docs

A project of short tutorials and how-to guides for Coq features and Coq Platform packages.
https://coq.inria.fr/platform-docs/
Other
19 stars 10 forks source link

Tips and Good Practices #23

Closed thomas-lamiaux closed 2 months ago

thomas-lamiaux commented 4 months ago

This is a collaborative pull request to gather tips and good practices for writing Coq code. It addresses casual but regular Coq users but not power users and aims to gather mostly uniformly accepted good practices.

If you would like to contribute, to facilitate collaboration, we recommend using github's code suggestions that ease reviewing and collaborative discussions. Alternatively, you can also make short PR to this one.

When suggesting tips, keep in mind they can be different solutions to a problem, so do not present something as "the solution" but "a solution" that comes with its advantages and inconvenient.

For instance, we all agree that we should not directly use variables named by Coq, but then there are different solutions that are not necessarily excluded:

For the moment, there is no fixed structure, but we could imagine sections like "tips for resilient code", "tips for efficiency" etc...