Add community health files and modern Python best practices#21
Merged
Conversation
Co-authored-by: jpmccu <602385+jpmccu@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add community health files and best practices
Add community health files and modern Python best practices
Jan 19, 2026
jpmccu
approved these changes
Jan 22, 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.
Implements comprehensive project governance, security, and contributor infrastructure for the setlr repository.
Community Health Files
./script/bootstrap, PEP 8/257 standards, nose2 testing, commit conventions, PR process, pre-commit hooksGitHub Templates
.yml) - Required fields for environment (SETLr/Python/OS versions), reproduction steps, sample data.yml) - Problem/solution descriptions, use case analysis, feature area classification, priority levelsDependency Management
pyproject.toml(18 packages)Documentation
Created missing advanced topics referenced in README but previously absent:
CI/CD Enhancements
v*tags: extracts version-specific changelog, creates GitHub release, builds distributions, publishes to PyPItwine checkfor package validation on Python 3.11Code Quality
setup.cfg), isort (black profile), standard hooks (trailing-whitespace, end-of-file-fixer, check-yaml, check-merge-conflict)README Updates
Post-Merge Setup Required
PYPI_API_TOKENsecret to repository settingspre-commit installin local development environmentsOriginal prompt
Add Community Health Files and Modern Best Practices
Overview
Implement best practices to improve project governance, security, and contributor experience for the setlr repository.
Files to Create
1. Community Health Files
CONTRIBUTING.md
Create a comprehensive contributing guide that includes:
./script/bootstrap)script/directoryCODE_OF_CONDUCT.md
Create a Code of Conduct based on Contributor Covenant v2.1:
SECURITY.md
Create a security policy that includes:
2. GitHub Templates
.github/PULL_REQUEST_TEMPLATE.md
Create a PR template with sections for:
.github/ISSUE_TEMPLATE/bug_report.yml
Create a structured bug report template with fields for:
.github/ISSUE_TEMPLATE/feature_request.yml
Create a feature request template with fields for:
3. Dependency Management
.github/dependabot.yml
Configure Dependabot for:
requirements.txt
Extract production dependencies from pyproject.toml:
requirements-dev.txt
Create development dependencies file:
4. Documentation Enhancement
docs/advanced.md
Create the missing advanced features documentation that is referenced in docs/README.md but doesn't exist:
5. CI/CD Enhancements
.github/workflows/build.yml
Create a build and publish workflow:
python -m build.github/workflows/release.yml
Create a release workflow:
6. Code Quality Tools
.pre-commit-config.yaml
Configure pre-commit hooks:
Update CONTRIBUTING.md to include pre-commit setup instructions.
7. Updated README.md
Add to the README.md file:
Implementation Notes
Compatibility
Style Consistency
Testing
Success Criteria
This pull request was created from Copilot chat.
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.