Add documentation for reuse of mapreader #459
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rwood-97
approved these changes
Jul 22, 2024
|
So shall I just merge this, and disregard the failing tests? |
|
Have just merged main, should be fixed now and can merge |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #459 +/- ##
=======================================
Coverage 62.77% 62.77%
=======================================
Files 41 41
Lines 6807 6807
=======================================
Hits 4273 4273
Misses 2534 2534
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Added a section on the contribution guide for MapReader to contribute stories/case studies of how people are working with MapReader. This has made me think that we need a restructuring of the documentation pretty badly, as it's becoming quite unwieldy currently. But, at least we have this section now. Still remaining is to update tehe "Examples of User Stories" section with some real-world examples. @rwood-97 and @kmcdono2, can you think of any that would make good examples here?
Fixes #294
Describe your changes
Added a section on the contribution guide for MapReader to contribute stories/case studies of how people are working with MapReader.
Checklist before assigning a reviewer (update as needed)
Reviewer checklist