CODE CLINIC MEOM 10/04 - general structure

[Amine-ouhechou]

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

• Package has a README.md file in the root directory.
• Package documentation is easy to find.
• The package is easy to install
• 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
• Metadata including author(s), author e-mail(s), a url, and any other relevant metadata e.g., in a pyproject.toml file or elsewhere.

[noemieplanat]

• Package has a README.md file in the root directory
• Package documentation is easy to find.
• The package is easy to install
  • create .yml file
  • Specify that pyinterp should be intalled before with conda
  • Update the exemple in the documentation
• License: Does the repository contain a plain-text LICENSE or COPYING file with the contents of an OSI approved software license? ->yes
• 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 -
• Metadata including author(s), author e-mail(s), a url, and any other relevant metadata e.g., in a pyproject.toml file or elsewhere