Add CONTRIBUTING.rst file and tests for it #14
Merged
Conversation
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
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds a CONTRIBUTING.rst file template to help contributors set up the project for local development, along with tests to verify its correct generation.
- Adds a comprehensive
CONTRIBUTING.rst.jinjatemplate with guidelines for bug reporting, feature suggestions, and local development setup - Updates test suite to verify the CONTRIBUTING.rst file is generated correctly and contains expected content
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| tests/test_copier.py | Adds CONTRIBUTING.rst to the file existence test and creates a new parametrized test to verify specific content appears in the generated file |
| template/CONTRIBUTING.rst.jinja | Introduces a new template file with contribution guidelines, including setup instructions for local development with conda/pip and git workflow best practices |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
ahms5
added
enhancement
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.
Changes proposed in this pull request:
CONTRIBUTING.rstwith instructions on how to set up the new package for local development has been added.test_copier.pyfile was updated to check for the correct creation of theCONTRIBUTING.rstfile.