Skip to content

Add Engineering Guidelines to Sia Repo

Matthew Sevey requested to merge sevey-engineering-guidelines into master

MERGE REQUEST

MR Guidelines

Overview

This MR brings the engineering guidelines created in the google doc into the Sia repo. Comments from the google doc have been incorporated or issues have been created to follow up.

Now that the guidelines are in the repo, we can address discussions and updates on various sections. It is not my intention for those discussions to happen in this MR. I encourage any discussion to create a follow up issue to address it.

Issues created

#4159
#4160
#4161
#4162
#4170
sia.tech#14

Example for Visual Changes

Checklist

Review and complete the checklist to ensure that the MR is complete before assigned to an approver.

  • All new methods or updated methods have clear docstrings
  • Testing added or updated for new methods
  • Any new packages are added to Makefile and .gitlab-ci.yml
  • API documentation updated for API updates
  • Module README.md updated for changes to workflow
  • Issue added to Sia-UI repo for new supporting features
  • Changelog File Created

Issues Closed

Edited by Matthew Sevey

Merge request reports