-
Notifications
You must be signed in to change notification settings - Fork 12.7k
docs: Added initial PR template with directions for doc only changes and squash merges [no ci] #7700
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
mofosyne
merged 11 commits into
ggml-org:master
from
nicolasperez19:docs-no-ci-pr-template
Jun 9, 2024
Merged
docs: Added initial PR template with directions for doc only changes and squash merges [no ci] #7700
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
522fe3b
doc: Added to README that collaborators should follow PR template
nicolasperez19 b449ca8
doc: Added general pull request template with directions for doc only…
nicolasperez19 6cf0a87
doc: Moved contributing info from PR template to separate CONTRIBUTIN…
nicolasperez19 8cc1741
docs: Added link in README to pull request template
nicolasperez19 1064043
doc: Simplified PR template, referenced ggml-ci and test commands
nicolasperez19 3de6557
doc: Moved all PR template information to CONTRIBUTING.md
nicolasperez19 e79bc7e
doc: Made PR template only contain a line that a collaborator has rea…
nicolasperez19 dc8809d
Update CONTRIBUTING.md [no ci]
mofosyne 2157560
Update README.md
mofosyne 9fef7a8
Update pull_request_template.md [no ci]
mofosyne 042089d
Update CONTRIBUTING.md to clarify review complexity labeling [no ci]
mofosyne File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Pull Request Template | ||
|
||
## Summary | ||
|
||
* [Briefly describe the changes made in this PR.] | ||
* [Include any relevant context, such as the issue or feature being addressed.] | ||
|
||
## Changes Made | ||
|
||
* [List specific files or directories affected by these changes] | ||
* [Describe any significant updates, rewrites, or new code added] | ||
* [Mention any removed or deleted files or code] | ||
|
||
## Relevant Details | ||
|
||
* **Affected Code**: [List specific code paths, functions, or classes changed or updated] | ||
* **Impact**: [Explain how the changes affect the project's functionality, performance, or security] | ||
* **New Features/Changes**: [Describe new features or significant changes added in this PR] | ||
* **Fixed Issues**: [List specific issues or bugs fixed by these changes] | ||
|
||
## Verification | ||
|
||
To verify this PR, you can: | ||
|
||
* Run automated tests or scripts to ensure the changes do not introduce errors | ||
* Review code for style, security, and best practices | ||
* Verify that all changed files are properly formatted and consistent | ||
|
||
nicolasperez19 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
## Additional Information (Optional) | ||
|
||
[Add any additional context, explanations, or requests that are relevant to this PR.] | ||
|
||
**Important Notes** | ||
|
||
* If this pull request only contains documentation changes (e.g., updating | ||
READMEs, adding new wiki pages), please add `[no ci]` to the commit title. | ||
This will skip unnecessary CI checks and help reduce build times. | ||
* When squashing multiple commits on merge, use the following format for | ||
your commit title: `<module>:<commit title> (#<issue_number>)`. For example: `utils: Fix typo in utils.py (#1234)` | ||
* Please ensure that this PR follows our contributing guidelines, available at [](README.md). This includes formatting code according to our style guide and ensuring that all changes are thoroughly tested. | ||
nicolasperez19 marked this conversation as resolved.
Show resolved
Hide resolved
|
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
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.
Uh oh!
There was an error while loading. Please reload this page.