Skip to content

Added architecture and testing documentation #84

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
Merged
merged 2 commits into from
Jul 6, 2019
Merged

Added architecture and testing documentation #84

merged 2 commits into from
Jul 6, 2019

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg commented Jul 5, 2019 •
edited
Loading

PR Checklist

Overview

Splits content other than setup instructions from docs/Development.md into:

  • Architecture.md: How the general app structure operates
  • Dependencies.md How functions pass and receive static dependencies
  • Testing.md: Unit and end-to-end tests

Adds comments to source code mentioning places also mentioned in docs, particularly src/conversion/convertConfig.ts.

egiurleo
egiurleo reviewed Jul 6, 2019
View reviewed changes
egiurleo
egiurleo approved these changes Jul 6, 2019
View reviewed changes
Copy link
Contributor

@egiurleo egiurleo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This adds a lot of useful information! ✨

@JoshuaKGoldberg JoshuaKGoldberg merged commit 9cbfa34 into master Jul 6, 2019
@JoshuaKGoldberg JoshuaKGoldberg deleted the architecture-docs branch July 6, 2019 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@egiurleo egiurleo egiurleo approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document converters, mergers, and how they're resolved
2 participants
@JoshuaKGoldberg @egiurleo