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

Dev Docs #38

Open
mpacer opened this issue Apr 1, 2019 · 0 comments
Open

Dev Docs #38

mpacer opened this issue Apr 1, 2019 · 0 comments

Comments

@mpacer
Copy link
Member

mpacer commented Apr 1, 2019

In conversation with @MSeal I raised an issue that as a new developer it is somewhat difficult to begin contributing to this project. Out of concerns around bus-factor and long term sustainability, we arrived at the idea that we should have better developer documentation.

This came up in part because of #37 and how much is changing as a result of introducing external reference based storage. I in part wouldn't know how to review it because I don't know how it relates to the current way of internally organizing all of the logic.

My proposal is that before making massive architectural changes, we should try to express how the pieces are intended to work together today. That way the changes can be described at a higher level that is distinct from the details of the implementation.

In the nteract meeting, @captainsafia suggested that we create this issue and tag @willingc who has been amazing for helping solidify efforts like these.

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