Expand CONTRIBUTING.md with development setup and guidelines#115
Closed
leofernandezg wants to merge 1 commit intocdelker:masterfrom
Closed
Expand CONTRIBUTING.md with development setup and guidelines#115leofernandezg wants to merge 1 commit intocdelker:masterfrom
leofernandezg wants to merge 1 commit intocdelker:masterfrom
Conversation
The contributing guide was a 3-line stub. Expanded to cover: - Bug reporting guidelines with checklist - Development environment setup (venv, editable install) - How to run the test suite (pytest + nbval) - Code style conventions (line length, PEP 8, type hints) - Pull request workflow and expectations - Step-by-step guide for adding new elements - Documentation build instructions
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
2 participants
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
Expands the contributing guide from a 3-line stub to a comprehensive developer onboarding document.
Changes
pytest --nbval-lax)Test results
Fixes #118