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

Version control #9

Open
SyntaxColoring opened this issue Apr 7, 2020 · 0 comments
Open

Version control #9

SyntaxColoring opened this issue Apr 7, 2020 · 0 comments

Comments

@SyntaxColoring
Copy link
Collaborator

SyntaxColoring commented Apr 7, 2020

Using this ticket as a scratchpad for my scattered thoughts. Bear with me.

Problems

  • We don't have easily referenceable release notes.
  • We keep giving the operators similarly named files, which is confusing.
  • It's not obvious, from just a filename, what is being run and what instructions should be followed.
  • Me being the one person to update the docs on protocols.io is a bottleneck.

Implementation notes

  • Any version counters should be started artificially high (like at 20), to avoid confusion with existing filenames like V15-StationB-8samples.py.
  • Filenames should include the version identifier.
  • For development, we shouldn't have to worry about bumping the version number after every little change.
  • Version identifiers must be clear and easily comparable. A monotonic counter or a date is probably fine. A Git SHA1 is probably not.

Open questions

  • Labware?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant