Skip to content

Add documentation contribution guide to CONTRIBUTING.md#91

Open
aman-coder03 wants to merge 1 commit intopysal:mainfrom
aman-coder03:contributing-guide
Open

Add documentation contribution guide to CONTRIBUTING.md#91
aman-coder03 wants to merge 1 commit intopysal:mainfrom
aman-coder03:contributing-guide

Conversation

@aman-coder03
Copy link
Copy Markdown

Summary

Fixes #90

Adds a ### Documentation section to CONTRIBUTING.md covering how to build the docs locally and how to add example notebooks, including how to test them with nbmake and guidelines for what makes a good notebook contribution.

@codecov
Copy link
Copy Markdown

codecov bot commented Feb 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.96%. Comparing base (5b8382d) to head (9b54345).
⚠️ Report is 4 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@martinfleis
Copy link
Copy Markdown
Member

The exact shape of contributing guides across PySAL will be discussed and synchronised. Putting this on hold.

@aman-coder03
Copy link
Copy Markdown
Author

Understood, happy to wait. Let me know once the discussion is settled and i will update accordingly

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] Add documentation contribution guide for notebooks and docs build

2 participants