opensource/mattermost
3
0
Fork 0
mirror of https://github.com/mattermost/mattermost.git synced 2026-09-01 15:00:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

Simplify PULL_REQUEST_TEMPLATE.md and document it in AGENTS.md (#36239)

Browse Source
This commit is contained in:
Jesse Hallam
2026-04-24 09:44:44 -03:00
committed by GitHub
parent 9c684e6313
commit 5817a6d687
2 changed files with 18 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/PULL_REQUEST_TEMPLATE.md
+14 -43
View File
@@ -1,59 +1,30 @@
<!-- Thank you for contributing a pull request! Here are a few tips to help you:
1. If this is your first contribution, make sure you've read the Contribution Checklist https://developers.mattermost.com/contribute/getting-started/contribution-checklist/
2. Read our blog post about "Submitting Great PRs" https://developers.mattermost.com/blog/2019-01-24-submitting-great-prs
3. Take a look at other repository specific documentation at https://developers.mattermost.com/contribute
-->
<!-- Summary and Release Note are required. Include Ticket Link and Screenshots as needed. -->
#### Summary
<!--
A description of what this pull request does, as well as QA test steps (if applicable and if not already added to the Jira ticket).
-->
<!-- What does this PR do? Include QA steps if not covered in the ticket. -->
#### Ticket Link
<!--
If applicable, please include both or either of the following links:
Fixes https://github.com/mattermost/mattermost/issues/XXX
Jira https://mattermost.atlassian.net/browse/MM-XXX
Fixes: https://github.com/mattermost/mattermost/issues/XXX
Fixes: https://mattermost.atlassian.net/browse/MM-XXX
-->
#### Screenshots
<!--
If the PR includes UI changes, include screenshots/GIFs.
For an easier comparison of UI changes a table (template below) can be used.
| before | after |
|----|----|
| <insert before screenshot here> | <insert after screenshot here> |
-->
<!-- Include screenshots or GIFs for UI changes. -->
#### Release Note
<!--
Add a release note for each of the following conditions:
Write a release note if this PR includes any of:
* API or config changes.
* Schema migrations (added/dropped tables or columns, index changes, column type changes).
* User-visible behavior changes (UI, CLI, websocket).
* Deprecations, breaking changes, or compatibility notes.
* Config changes (additions, deletions, updates).
* API additions—new endpoint, new response fields, or newly accepted request parameters.
* Database changes (any).
* Schema migration changes. Use the [Schema Migration Template](https://docs.google.com/document/d/18lD7N32oyMtYjFrJKwsNv8yn6Fe5QtF-eMm8nn0O8tk/edit?usp=sharing) as a starting point to capture these details as release notes.
* Websocket additions or changes.
* Anything noteworthy to a Mattermost instance administrator (err on the side of over-communicating).
* New features and improvements, including behavioral changes, UI changes, and CLI changes.
* Bug fixes and fixes of previous known issues.
* Deprecation warnings, breaking changes, or compatibility notes.
The release-note block must always be present. Use past tense. Write NONE if none of the above apply. Newlines are stripped.
If no release notes are required, write NONE. Use past-tense. Newlines are stripped.
Examples:
```
Added new API endpoints POST /api/v4/foo, GET api/v4/foo, and GET api/v4/foo/:foo_id.
```
```
Added a new config setting ServiceSettings.FooBar. Added a new column Foo to the Users table.
Example:
```release-note
Added new API endpoints POST /api/v4/foo and GET /api/v4/foo/:foo_id.
```
```release-note
AGENTS.md
+4
View File
@@ -13,3 +13,7 @@ cd server && make bump-enterprise
```
This requires the enterprise directory to be present (configured via `BUILD_ENTERPRISE_DIR`). Commit the updated `enterprise.pin` as part of your server pull request.
## Pull Requests
When creating a pull request, follow `.github/PULL_REQUEST_TEMPLATE.md`.