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

Create a design doc for this project #8

Open
maaverik opened this issue Dec 22, 2021 · 0 comments
Open

Create a design doc for this project #8

maaverik opened this issue Dec 22, 2021 · 0 comments
Assignees

Comments

@maaverik
Copy link
Contributor

maaverik commented Dec 22, 2021

We have one for the frontend repo, which details the tools used and guidelines on what components should go where.

In this repo's case, I feel that there aren't going to be many tools used, but a brief description of the different components, intended folder structure, and overall flow of data would be useful not just for us to be on the same page, but also for more experienced go programmers to guide us and contribute more easily.

Once we have a decent design doc ready, we could also set up individual GitHub issues or maybe a checklist of things to do, because there aren't a lot of sync ups between contributors except through PRs right now. Discussing the design of components in issues worked well for the frontend repo, it helped new contributors get up to speed from looking at the discussions and allowed them a space to ask questions.

The design doc just needs to give a high-level overview. For more up-to-date and specific information, let's add inline documentation that can be rendered with godoc. This gives a quick cheatsheet on how to create inline documentation in go.

More discussions here: https://github.com/SimplQ/simplQ-golang/pull/7/files#issuecomment-999458450

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

2 participants