[meom code clinic] general structure (having a readme, a licence, contributing guide, etc)

[rcaneill]

This issue is open for the MEOM internal code clinic / review process

[rcaneill]

general structure (having a readme, a licence, contributing guide, etc)

• [x] Package has a README.md file in the root directory.
• [x] Package documentation is easy to find.
• [x] The package is easy to install
• [x] License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license?
• [ ] Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support
• [x] Metadata including author(s), author e-mail(s), a url, and any other relevant metadata e.g., in a pyproject.toml file or elsewhere.

[rcaneill]

doc: maybe add a link in the README (more visible than the badge)

[rcaneill]

doc: maybe add a link in the README (more visible than the badge)

They are links in the readme so it may be already good

[rcaneill]

Installation also worked for me

[rcaneill]

missing Community guidelines @vbellemin do you open a new issue?

[vbellemin]

Issue about "Community guidelines" is raised in #73 .

[lesommer]

Closing code review