search

UCSCLibrary / dams_project_mgmt

DAMS purpose is to provide access to digitized and born-digital UCSC Special Collections content. This repository is used for project planning. It holds the task tickets and roadmap for the different projects under DAMS.
2 stars 0 forks source link

Code Documentation & Style Standards #75

Open kellyChex opened 5 years ago

kellyChex commented 5 years ago

This epic needs to be fleshed out; hopefully this can occur over the course of Ned and Ryan's consultation with Notch8.

Descriptive Summary

Acceptance Criteria

This is what done looks like:

Related Work

Testing and documentation standards for new development #256

rschwab commented 4 years ago

Here's a potential starting point: https://samvera.github.io/code.html

NedHenry commented 4 years ago

Rob gave us some useful general advice about striking a balance between commenting everything and nothing. We could still use some more concrete best practices. Maybe we should consider working Rubocop into our development workflow somehow? Rubocop is a tool to enforce style rules. We don't necessarily want to waste time enforcing strict style rules for our whole codebase, but we could use the tool to store our stylistic best practices and keep track of all the ways we deviate from those. That's an idea to discuss between Ned and Ryan. If we do go that route, detailed discussion about Rubocop configuration could be a topic for a future meeting with Rob.