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.

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

Preparing Software Publication #18

Open
29 of 31 tasks
dataspider opened this issue Oct 26, 2023 · 0 comments
Open
29 of 31 tasks

Preparing Software Publication #18

dataspider opened this issue Oct 26, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@dataspider
Copy link
Collaborator

dataspider commented Oct 26, 2023

Checklist

Primary responsibilities assigned following our discussion, feel free to modify/object.
Once an item is considered done, check its box.
Async discussion in the thread for this issue.

General checks

  • Source code publicly available on GitHub
  • OSI approved plain-text LICENSE file
  • Author contribution

Functionality

  • Installation possible via pypi @arashbm
  • Cleaner handling of Networkx dependency @arashbm
  • Networkx 3.x support (optional) @arashbm
  • Graphlet functionality (handling Bliss dependency: make it compatible w/ Python 3, replace by SOTA graph isomorphism library, ...?) @arashbm + @ercco
  • Update project requirements/toml to reflect Networkx 3.x support @arashbm

Code quality

  • (Almost) full test coverage @ercco (graphlet + sampling functionality), all others for the rest
  • Automated testing (GitHub actions) @arashbm
  • Codecov integration (optional) @dataspider
  • Codeclimate integration (optional) @dataspider

Documentation

  • Installation instructions + clearly stated list of dependencies + automated package management @arashbm
  • Automated documentation (sphinx + GitHub actions) @arashbm
  • Code of conduct (w/ MK contact webpage as default contact point) @dataspider

Writeup

  • Separate "publication" branch @dataspider
  • Writing folder "paper" with "paper.md" and "paper.bib" in it @dataspider
  • Summary of purpose and high-level functionality @bolozna (first draft)
  • Statement of need @ercco (first draft)
  • State of the field ("related packages", papers using pymnet already) @ercco (first draft)
  • Example usage with code examples and pretty figures @ercco + @dataspider
  • High-quality writing @dataspider
  • Complete references using rmarkdown citation syntax @dataspider
  • Check acknowledgements section + add grant number @bolozna

Bells and Whistles

  • Docstrings for remaining API methods + add to references.rst @ercco (graphlet + sampling functionality)
  • Other CI (incl. updating pypi package) @arashbm
  • State-of-the-art example data provision @dataspider
  • Example usage (old tutorials -> ipynb tutorials) @dataspider
  • Proof-reading all tutorials @dataspider
  • Proof-reading all docstrings @dataspider
  • Community guidelines (see GitHub's templates) @dataspider @arashbm
@dataspider dataspider added the documentation Improvements or additions to documentation label Oct 26, 2023
@dataspider dataspider added enhancement New feature or request and removed documentation Improvements or additions to documentation labels Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant