SG-21015 Add PR template #294
Open
+24
−0
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
julien-lang
reviewed
Apr 9, 2025
|
@julien-lang it seems it's possible. However, going this path we cannot make exceptions and will affect every repo. Although every repo can override its contents. |
Yes, I think I like this option. |
There was a problem hiding this comment.
Pull Request Overview
Adds a standardized PR template and updates the Python README with an Apple Silicon notice
- Introduces
pull_request_template.mdcontaining a merge checklist - Inserts an “Apple Silicon” section in
resources/python/README.mdto document CI behavior
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| resources/python/README.md | Added “Apple Silicon” heading and usage notes |
| pull_request_template.md | Created PR template with Jira, tests, and requirements checklist |
Comments suppressed due to low confidence (2)
resources/python/README.md:204
- Change “a Intel macOS” to “an Intel macOS” to correct the article before a vowel sound.
> Important Notice for Apple Silicon: CI uses a Intel macOS to install the binary requirements.
pull_request_template.md:15
- [nitpick] Use consistent markdown indentation (e.g., two spaces) for nested list items under “Requirements updates” to improve readability.
- - **Main pull request**
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.
Description wrote by copilot
This pull request introduces a new pull request template to standardize the process and updates the documentation for handling Python binary requirements on Apple Silicon. Below are the key changes:
Pull Request Workflow Enhancements:
pull_request_template.mdto guide contributors in documenting the purpose of changes, ensuring checklist items like Jira ticket references, component logic updates, and unit tests are addressed. It also includes specific instructions for handling requirements updates and automated branch workflows.Documentation Updates:
resources/python/README.mdto include a subsection for Apple Silicon, clarifying the handling of Python binary requirements for_cffi_backendand_zope_interface_coptimizationson Intel-based macOS CI environments.