Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

enhance CONTRIBUTING.md file #406

Open
5 tasks
slayoo opened this issue Feb 3, 2025 · 0 comments
Open
5 tasks

enhance CONTRIBUTING.md file #406

slayoo opened this issue Feb 3, 2025 · 0 comments

Comments

@slayoo
Copy link
Member

slayoo commented Feb 3, 2025 •
edited
Loading

  • 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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@slayoo