CONTRIBUTING.md Typo fixes and Markdown conventions #1290
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
Signed-off-by: Nathan McDougall <[email protected]>
nathanjmcdougall
force-pushed
the
doc/contributing-typo
branch
from
9f50cf5 to
97c313d
Compare
nathanjmcdougall
changed the title
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #1290 +/- ##
=======================================
Coverage 93.82% 93.82%
=======================================
Files 90 90
Lines 6704 6704
=======================================
Hits 6290 6290
Misses 414 414 ☔ View full report in Codecov by Sentry. |
cosmicBboy
approved these changes
Aug 14, 2023
| #### Adding New Dependencies | ||
|
|
||
| To add new dependencies to the project, make sure to alter the *environment.yml* file. Then to sync the dependencies from the *environment.yml* file to the *requirements-dev.txt* run the following command | ||
| To add new dependencies to the project, make sure to alter the _environment.yml_ file. Then to sync the dependencies from the _environment.yml_ file to the _requirements-dev.txt_ run the following command |
There was a problem hiding this comment.
this is fine, but *this* and _this_ are equivalent, no?
There was a problem hiding this comment.
They are. This is for consistency with earlier in the document where underscores are used.
My motivation is to follow this rule provided by markdownlint:
https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md049.md
It's pedantry, ultimately.
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.
No description provided.