Open
Conversation
Contributor
|
Chiming in to publicly say that I support the changes in this draft; I think it strictly improves things. I would assign this PHEP number 9 when ready. Sorry for not suggesting new best practices nor reference implementations, but I'm already particularly happy with the current "best practices" content. Hoping community members will offer reference implementations. |
| <a name="reference-implementations"></a> | ||
| Several PyHC projects provide examples of best practices for development practices, and they should be provided here. | ||
|
|
||
| [pyspedas](https://github.com/spedas/pyspedas?tab=readme-ov-file) provides automated tests, static checks, and coverage (do we have a better place to link in the repository?). It uses [coveralls](https://coveralls.io/) for [test coverage](https://coveralls.io/github/spedas/pyspedas): [workflow configuration](https://github.com/spedas/pyspedas/blob/master/.github/workflows/pythonpackage.yml). |
Collaborator
There was a problem hiding this comment.
We've retired this pyspedas coverage workflow. It's been replaced with a version that splits the tests up into groups, and runs them in paralllel jobs, bringing the wall-clock runtime down from 6+ hours to more like 90 minutes. New workflow is here: https://github.com/spedas/pyspedas/blob/master/.github/workflows/full_coverage.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PHEP updates standards 7, 9, and 14; these are part of the "software maturity" and "testing" guidelines. It relates to #35 but does not close it.
I really need more examples for the "best practices" section! Please, be bold and suggest!
The changes here are really tiny so I'm not doing any polling (unless someone wants it!). Similarly, there's no tiering (which I guess means this technically doesn't depend on PHEP 4). The meat of this really is in the "best practices" and "how to teach" sections, and trying to make good stuff visible and easy to replicate.