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.

Sign up for GitHub

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

Jump to bottom

Add Development Guide #487

Open
andrewkrug opened this issue Dec 30, 2019 · 3 comments
Open

Add Development Guide #487

andrewkrug opened this issue Dec 30, 2019 · 3 comments

Comments

@andrewkrug
Copy link
Contributor

For contribution friendliness we should have a development / getting-started guide.
@gene1wood
Copy link
Contributor

Include

  • Diagram / drawing / description of the system, it's components and how the interact with each other
  • The workflow to take a modification in some piece of source code and move it all the way through to be deployed in production

@andrewkrug
Copy link
Contributor Author

We've already got architecture diagrams in the docs/ folder.

I'll add a development guide though.

@andrewkrug
Copy link
Contributor Author

In looking at the README I actually think this is well covered. Can you give a glance and see where the gaps are?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gene1wood @andrewkrug