Add contributor guidelines to development documentation#313
Merged
JohnGriffiths merged 2 commits intomainfrom Mar 16, 2026
Merged
Add contributor guidelines to development documentation#313JohnGriffiths merged 2 commits intomainfrom
JohnGriffiths merged 2 commits intomainfrom
Conversation
Co-authored-by: JohnGriffiths <397826+JohnGriffiths@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add contributor guidelines to documentation page
Add contributor guidelines to development documentation
Mar 16, 2026
JohnGriffiths
approved these changes
Mar 16, 2026
JohnGriffiths
approved these changes
Mar 16, 2026
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.
The development documentation page was a placeholder ("coming soon..."). This PR populates it with a full contributor guide modeled after MNE-Python and Nilearn.
Changes
doc/documentation/development/index.rstdoc/documentation/development/contributing.rstOriginal prompt
Add contributor guidelines to the documentation page at documentation/development/index.md (shown at https://griffithslab.github.io/whobpyt/documentation/development/index.html).
The guidelines should be modeled after the contributor guides from established neuroimaging projects MNE-Python and Nilearn. Include the following sections:
Format with appropriate headings, markdown list formatting, and links where applicable. Do not remove any useful existing content from the page. If content exists, please append or integrate clearly.
The following is the prior conversation context from the user's chat exploration (may be truncated):
User: make me some suggestions to improve the whobpyt website pages at https://github.com/griffithslab/whobpyt
Assistant: Here are some suggestions to improve the whobpyt website pages, based on best practices for open-source scientific software, typical user expectations, and standard GitHub Pages conventions:
1. Enhance the Project Landing Page (README.md)
2. Dedicated Website Content (Docs or GitHub Pages)
3. Navigation and Appearance
4. Technical Improvements
5. Community and Outreach
Would you like detailed example layouts or recommended open-source templates for any of these suggestions? If you have a specific doc generator (Sphinx, MkDocs, etc.), I can tailor guidance accordingly.
User: this is the built website fyi
https://griffithslab.github.io/whobpyt/
Assistant: Thank you for sharing your current built website: https://griffithslab.github.io/whobpyt/
Based on the typical layout and contents of scientific software documentation sites, and combining that with my previous suggestions, here is feedback specifically tailored to improving your whobpyt website:
Review & Suggestions for https://griffithslab.github.io/whobpyt/
1. Homepage Improvements
Op...
This pull request was created from Copilot chat.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.