Skip to content

enhance CONTRIBUTING.md file #406

Description

@slayoo
  • explain how to run the tests
  • explain how to add new tests
  • explain why in the C++ code we use static methods manually taking a reference to self
  • explain why it is OK to have compiled-in symbols for libs such as hdf5, SUNDIALS, and why it does not conflict with these symbols being used from other libs like SciPy (see also test python import of something that uses sundials (if no symbol clash?) #16)
  • explain how to contribute to the documentation at the API docstring level (+ how it relates to PartMC Doxygen strings and how it is used by pdoc)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions