Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Add CONTRIBUTING.md file with comprehensive contribution guidelines #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
woodruffw merged 3 commits into main from copilot/fix-165
Sep 6, 2025

Conversation

Copy link
Contributor

@Copilot Copilot AI commented Aug 14, 2025
edited
Loading

This PR adds a comprehensive CONTRIBUTING.md file to provide a welcoming place for contributors to understand how to contribute to the stdlib-list project.

The new contribution guide includes:

  • Welcoming introduction for new contributors with clear project overview
  • Development setup instructions using the existing make dev workflow
  • Code quality standards covering Ruff linting, MyPy type checking, and the 100% test coverage requirement
  • Documentation build instructions using Sphinx
  • Clear submission process with GitHub workflow guidelines
  • Quick reference table of useful make commands for easy access
  • Links to existing documentation including the module inclusion policy
  • Project history context acknowledging the original maintainers and project transfer

The guidelines document the existing well-established development infrastructure without changing any code, making this a minimal but complete addition. All documented commands have been validated to work correctly with the current project setup.

This provides new contributors with everything they need to get started quickly while maintaining the project's high standards for code quality, testing, and documentation.

Fixes #165.


💬 Share your feedback on Copilot coding agent for the chance to win a 200ドル gift card! Click here to start the survey.

Copy link
Contributor Author

Copilot AI commented Aug 14, 2025

@miketheman 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs.

I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review.

Co-authored-by: miketheman <529516+miketheman@users.noreply.github.com>
@Copilot Copilot AI changed the title (削除) [WIP] Add a CONTRIBUTING.md file (削除ここまで) (追記) Add CONTRIBUTING.md file with comprehensive contribution guidelines (追記ここまで) Aug 14, 2025
@Copilot Copilot AI requested a review from miketheman August 14, 2025 21:15
Copilot finished work on behalf of miketheman August 14, 2025 21:15
@miketheman miketheman marked this pull request as ready for review September 5, 2025 21:56
@woodruffw woodruffw merged commit c32a793 into main Sep 6, 2025
13 checks passed
@woodruffw woodruffw deleted the copilot/fix-165 branch September 6, 2025 02:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@woodruffw woodruffw woodruffw approved these changes

+1 more reviewer

@miketheman miketheman miketheman approved these changes

Reviewers whose approvals may not affect merge requirements
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add a CONTRIBUTING.md file

AltStyle によって変換されたページ (->オリジナル) /