Add documentation contribution guide to CONTRIBUTING.md#91
Open
aman-coder03 wants to merge 1 commit intopysal:mainfrom
Open
Add documentation contribution guide to CONTRIBUTING.md#91aman-coder03 wants to merge 1 commit intopysal:mainfrom
CONTRIBUTING.md#91aman-coder03 wants to merge 1 commit intopysal:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #91 +/- ##
==========================================
+ Coverage 91.36% 92.96% +1.60%
==========================================
Files 6 6
Lines 799 825 +26
==========================================
+ Hits 730 767 +37
+ Misses 69 58 -11 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Member
|
The exact shape of contributing guides across PySAL will be discussed and synchronised. Putting this on hold. |
Author
|
Understood, happy to wait. Let me know once the discussion is settled and i will update accordingly |
This file contains hidden or 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
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
Fixes #90
Adds a
### Documentationsection toCONTRIBUTING.mdcovering how to build the docs locally and how to add example notebooks, including how to test them withnbmakeand guidelines for what makes a good notebook contribution.