choderalab/software-development

Issues

• Recommend using 'duecredit' to ensure downstream tools can properly cite all modules?

  #105 opened 3 years ago by jchodera
  1

• Add "care and feeding of a changelog and release notes"

  #104 opened 3 years ago by jchodera
  0

• Excise cookiecutter from PHILOSOPHY AND SCOPE

  #81 opened 3 years ago by jchodera
  0

• Continuous Integration: Recommend GitHub Actions

  #101 opened 3 years ago by jchodera
  0

• Add CI to automate testing for broken links

  #102 opened 3 years ago by jchodera
  0

• Add section on installing Python and configuring your development environment

  #96 opened 3 years ago by jchodera
  0

• Python Coding Conventions: Clarify docstring conventions, especially for array shapes

  #97 opened 3 years ago by jchodera
  1

• Unit Tests: Add sections on how to parameterize tests and build test fixtures

  #98 opened 3 years ago by jchodera
  0

• Unit Tests: Replace pymbar example with better examples

  #99 opened 3 years ago by jchodera
  0

• Unit Tests: Recommend pytest and explain rationale

  #100 opened 3 years ago by jchodera
  0

• Python Coding Convention: Add discussion of type annotations

  #92 opened 3 years ago by jchodera
  0

• Add information about setting up pre-commit CI

  #91 opened 3 years ago by jchodera
  0

• Add section on recommended libraries

  #93 opened 3 years ago by jchodera
  0

• Add section on writing command-line arguments (CLI)

  #95 opened 3 years ago by jchodera
  0

• Add section on serializing objects and reading/writing data

  #94 opened 3 years ago by jchodera
  0

• In VERSION_CONTROL.md change master to main

  #87 opened 3 years ago by mikemhenry
  0

• Move recommendations to top for all sections

  #88 opened 3 years ago by jchodera
  0

• Be more explicit about our current git workflow

  #89 opened 3 years ago by jchodera
  0

• Be explicit about why we work with branches instead of forks on lab repo

  #90 opened 3 years ago by jchodera
  0

• Create a single-page quickstart with pointers to more detail in other sections

  #82 opened 3 years ago by jchodera
  0

• Update cookiecutter (and fork to lab version) to be more up to date with current practices

  #85 opened 3 years ago by jchodera
  0

• Add licensing discussion about data (CC0) and documentation (CC-BY) licenses

  #83 opened 3 years ago by jchodera
  0

• Update Structuring your Project with current cookiecutter structure

  #84 opened 3 years ago by jchodera
  0

• Mention GitLab in Version Control section

  #86 opened 3 years ago by jchodera
  0

• Developers

  #78 opened 3 years ago by Kershi23
  0

• Software developer

  #80 opened 3 years ago by amirmurta
  0

• Add suggestions on how to create good minimal, reproducible examples

  #79 opened 3 years ago by jchodera
  0

• Which testing framework should we recommend? nose2 or pytest?

  #74 opened 5 years ago by jchodera
  6

• Python code formatter

  #62 opened 4 years ago by malramsay64
  3

• LiveCOMS Article based on this?

  #66 opened 6 years ago by justinGilmer
  8

• Mention Hypothesis in the advanced unittesting section

  #75 opened 5 years ago by pckroon
  0

• Update "Structuring your Project" to match updated MolSSI cookiecutter structure

  #73 opened 5 years ago by jchodera
  0

• Google guide to code reviews

  #70 opened 5 years ago by jchodera
  0

• Markdown tip

  #68 opened 6 years ago by CatChenal
  0

• Add expanded section describing code coverage assessment

  #67 opened 6 years ago by jchodera
  0

• Document standards for version numbers and releases

  #63 opened 6 years ago by jchodera
  3

• "steep learning curve"

  #64 opened 6 years ago by agrossfield
  0

• Add discussion of using a CLA to allow future software relicensing

  #60 opened 6 years ago by jchodera
  1

• Add explanation of branch (fork)/pull/merge model

  #40 opened 6 years ago by davidlmobley
  1

• Cookiecutter for Computational Chemistry Python Packages

  #57 opened 6 years ago by Lnaden
  4

• Create a boilerplate package these docs can reference

  #54 opened 6 years ago by Lnaden
  2

• Cross-check (and draw from?) Netherlands eScience book

  #56 opened 7 years ago by davidlmobley
  0

• Add admonition against crafting your own file formats

  #52 opened 7 years ago by jchodera
  1

• Code of Conduct?

  #51 opened 7 years ago by jchodera
  1

• Version control link

  #49 opened 7 years ago by agitter
  1

• Should the Document your code section in Python Coding Conventions be moved to Documentation?

  #47 opened 7 years ago by earosenz
  0

• Flesh out Advanced Topics section in Unit Testing

  #46 opened 7 years ago by earosenz
  0

• CI needs a little love to get it stylistically integrated with the rest of the repo

  #45 opened 7 years ago by earosenz
  0

• Create links from page to page in order of the table of contents

  #44 opened 7 years ago by earosenz
  1

• Broken link in Philosophy and Scope

  #36 opened 8 years ago by pgrinaway
  2