React/react-native
1
0
Fork 0
mirror of https://github.com/facebook/react-native.git synced 2024-11-22 06:29:46 +00:00
Code Issues Actions 15 Packages Projects Releases Wiki Activity
48ea6867a9
react-native/.github/PULL_REQUEST_TEMPLATE.md

22 lines
868 B
Markdown
Raw Normal View History

Update Pull Request and Issue templates. (#23187) Summary: As a maintainer, I noticed that the description for a PR is often missing, which makes it hard to understand why a change is made. Because some of the text isn't using HTML comments, the same text explaining how to fill out the changelog and test plan pops up and isn't removed by people. This PR fixes both of these issues. I also made another small update to the main issue template to urge people to use one of the other templates, with an explanation that we will close poorly formatted issues. Changelog: ---------- [General] [Changed] - Updated GitHub templates Pull Request resolved: https://github.com/facebook/react-native/pull/23187 Differential Revision: D13877752 Pulled By: cpojer fbshipit-source-id: 8ed88cde9151a41931848cccc669208cabe1e9ef
2019-01-30 16:28:01 +00:00
<!-- Thanks for submitting a pull request! We appreciate you spending the time to work on these changes. Please provide enough information so that others can review your pull request. The three fields below are mandatory. -->
Update guidelines. Summary: Consolidate tips on CONTRIBUTING.md, and reduce the wall of text when opening a new issue. Hoping this will encourage more people to read through the text. Closes https://github.com/facebook/react-native/pull/14518 Differential Revision: D5250443 Pulled By: hramos fbshipit-source-id: 91213c4ceca12225d9f54d1e1e81e020c6e463b3
2017-06-14 22:08:46 +00:00
Fix: Adapt template to new rules (#36705) Summary: Recently, we changed the logic to verify the body of a PR so that it is more compatible internally and externally, in both ways. But we forgot to update the template, so right now, all the created PR are incompatible with the internal PR checker. The required change is to have `:` after the Changelog title. For consistency, I added the `:` after ALL the titles. ## Changelog: [Internal] - Changed the PR template to align it to the new rules Pull Request resolved: https://github.com/facebook/react-native/pull/36705 Test Plan: No danger errors nor internal linter errors Reviewed By: christophpurrer Differential Revision: D44503519 Pulled By: cipolleschi fbshipit-source-id: 43963c3cf774d19d6de8e86b18b684e76dd0fe87
2023-03-29 16:17:53 +00:00
## Summary:
Update PULL_REQUEST_TEMPLATE.md Summary: Quick edit to ensure people are aware of the new docs location. Closes https://github.com/facebook/react-native/pull/17085 Differential Revision: D6492000 Pulled By: hramos fbshipit-source-id: 6ec2b5d2dadb30cefb1d23c740ca5449b3998468
2017-12-06 00:38:02 +00:00
Update Pull Request and Issue templates. (#23187) Summary: As a maintainer, I noticed that the description for a PR is often missing, which makes it hard to understand why a change is made. Because some of the text isn't using HTML comments, the same text explaining how to fill out the changelog and test plan pops up and isn't removed by people. This PR fixes both of these issues. I also made another small update to the main issue template to urge people to use one of the other templates, with an explanation that we will close poorly formatted issues. Changelog: ---------- [General] [Changed] - Updated GitHub templates Pull Request resolved: https://github.com/facebook/react-native/pull/23187 Differential Revision: D13877752 Pulled By: cpojer fbshipit-source-id: 8ed88cde9151a41931848cccc669208cabe1e9ef
2019-01-30 16:28:01 +00:00
<!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? -->
Make PR template consistent with Changelog (#22117) Summary: In the new changelog format, we're following [Keep a Changelog](https://keepachangelog.com/en/1.0.0). This change updates the PR template to follow their change types, plus it simplifies the *CATEGORY* field to follow the changelog's groupings. Some simplified examples have been provided, though I plan to revisit this after 0.58 to add real-world examples. This change is motivated by react-native-community/react-native-releases#47. Pull Request resolved: https://github.com/facebook/react-native/pull/22117 Differential Revision: D12919271 Pulled By: TheSavior fbshipit-source-id: 91f063f769357b24383db281545678b924ad3efb
2018-11-04 19:27:53 +00:00
Fix: Adapt template to new rules (#36705) Summary: Recently, we changed the logic to verify the body of a PR so that it is more compatible internally and externally, in both ways. But we forgot to update the template, so right now, all the created PR are incompatible with the internal PR checker. The required change is to have `:` after the Changelog title. For consistency, I added the `:` after ALL the titles. ## Changelog: [Internal] - Changed the PR template to align it to the new rules Pull Request resolved: https://github.com/facebook/react-native/pull/36705 Test Plan: No danger errors nor internal linter errors Reviewed By: christophpurrer Differential Revision: D44503519 Pulled By: cipolleschi fbshipit-source-id: 43963c3cf774d19d6de8e86b18b684e76dd0fe87
2023-03-29 16:17:53 +00:00
## Changelog:
Make PR template consistent with Changelog (#22117) Summary: In the new changelog format, we're following [Keep a Changelog](https://keepachangelog.com/en/1.0.0). This change updates the PR template to follow their change types, plus it simplifies the *CATEGORY* field to follow the changelog's groupings. Some simplified examples have been provided, though I plan to revisit this after 0.58 to add real-world examples. This change is motivated by react-native-community/react-native-releases#47. Pull Request resolved: https://github.com/facebook/react-native/pull/22117 Differential Revision: D12919271 Pulled By: TheSavior fbshipit-source-id: 91f063f769357b24383db281545678b924ad3efb
2018-11-04 19:27:53 +00:00
fix(internal, dangerfile): fix changelog entries for dangerfiles and PR template (#35541) Summary: A few days back leotm pointed out how the dangerfile was disaligned with the docs around the valid changelog entries for categories and types here: https://github.com/facebook/react-native/pull/35443#issuecomment-1327449113 I dug a bit deeper into the whole thing and went to the source of truth, which is the changelog generator, in particular here: https://github.com/microsoft/rnx-kit/blob/main/incubator/rn-changelog-generator/src/utils/getChangeDimensions.ts So I've updated the dangerfile to respect the options listed there. Also did a parallel PR on the website side: https://github.com/facebook/react-native-website/pull/3447 So now all comms will be aligned. ## Changelog <!-- Help reviewers and the release process by writing your own changelog entry. For an example, see: https://reactnative.dev/contributing/changelogs-in-pull-requests --> [INTERNAL] [FIXED] - fix changelog entries for dangerfiles and PR template Pull Request resolved: https://github.com/facebook/react-native/pull/35541 Test Plan: N/A Reviewed By: sammy-SC Differential Revision: D41686913 Pulled By: cortinico fbshipit-source-id: 2297b4a3209188bda4a609b60860de35c5e7e6df
2022-12-05 10:38:42 +00:00
<!-- Help reviewers and the release process by writing your own changelog entry.
Pick one each for the category and type tags:
[ANDROID|GENERAL|IOS|INTERNAL] [BREAKING|ADDED|CHANGED|DEPRECATED|REMOVED|FIXED|SECURITY] - Message
For more details, see:
(PULL_REQUEST_TEMPLATE) update link to changelog documentation (#34206) Summary: I just opened another PR and noticed the changelog page in the wiki redirected to the react native documentation. ## Changelog <!-- Help reviewers and the release process by writing your own changelog entry. For an example, see: https://github.com/facebook/react-native/wiki/Changelog --> [Internal] [Changed] - Update link to changelog documentation in PULL_REQUEST_TEMPLATE Pull Request resolved: https://github.com/facebook/react-native/pull/34206 Reviewed By: NickGerleman Differential Revision: D37920424 Pulled By: cortinico fbshipit-source-id: f4e47172a13fe5b42c29e320d34816b490a14b6c
2022-07-19 12:47:17 +00:00
https://reactnative.dev/contributing/changelogs-in-pull-requests
Make the link easier to copy. (#28516) Summary: Making a PR from GitHub, I need to copy-paste the link, and it would be easier to just triple-click a line with the URL rather than carefully selecting the URL from the text. <img width="723" alt="Screen Shot 2020-04-03 at 17 33 47" src="https://user-images.githubusercontent.com/100233/78378550-6c12af80-75d1-11ea-93a4-2eae568ce602.png"> ## Changelog [General] [Changed] - Make PR template easier to use with changelog URL. Pull Request resolved: https://github.com/facebook/react-native/pull/28516 Reviewed By: fkgozali Differential Revision: D20842238 Pulled By: hramos fbshipit-source-id: 3fef7a994f36a996bbbc52556600d468a56210a9
2020-04-03 18:49:34 +00:00
-->
Make PR template consistent with Changelog (#22117) Summary: In the new changelog format, we're following [Keep a Changelog](https://keepachangelog.com/en/1.0.0). This change updates the PR template to follow their change types, plus it simplifies the *CATEGORY* field to follow the changelog's groupings. Some simplified examples have been provided, though I plan to revisit this after 0.58 to add real-world examples. This change is motivated by react-native-community/react-native-releases#47. Pull Request resolved: https://github.com/facebook/react-native/pull/22117 Differential Revision: D12919271 Pulled By: TheSavior fbshipit-source-id: 91f063f769357b24383db281545678b924ad3efb
2018-11-04 19:27:53 +00:00
Fix: Adapt template to new rules (#36705) Summary: Recently, we changed the logic to verify the body of a PR so that it is more compatible internally and externally, in both ways. But we forgot to update the template, so right now, all the created PR are incompatible with the internal PR checker. The required change is to have `:` after the Changelog title. For consistency, I added the `:` after ALL the titles. ## Changelog: [Internal] - Changed the PR template to align it to the new rules Pull Request resolved: https://github.com/facebook/react-native/pull/36705 Test Plan: No danger errors nor internal linter errors Reviewed By: christophpurrer Differential Revision: D44503519 Pulled By: cipolleschi fbshipit-source-id: 43963c3cf774d19d6de8e86b18b684e76dd0fe87
2023-03-29 16:17:53 +00:00
## Test Plan:
Make PR template consistent with Changelog (#22117) Summary: In the new changelog format, we're following [Keep a Changelog](https://keepachangelog.com/en/1.0.0). This change updates the PR template to follow their change types, plus it simplifies the *CATEGORY* field to follow the changelog's groupings. Some simplified examples have been provided, though I plan to revisit this after 0.58 to add real-world examples. This change is motivated by react-native-community/react-native-releases#47. Pull Request resolved: https://github.com/facebook/react-native/pull/22117 Differential Revision: D12919271 Pulled By: TheSavior fbshipit-source-id: 91f063f769357b24383db281545678b924ad3efb
2018-11-04 19:27:53 +00:00
Bots cleanup, avoid leaving inline reviews when N>5 (#24923) Summary: This PR cleans up some of our GitHub bots. The overall goal is to make the contribution process just a tad nicer. ### analysis-bot * The bot will continue leaving GitHub Reviews when it finds lint issues, but will abstain from leaving inline comments if they would exceed 5 in number. * The review comment left by the bot has instructions on how to reproduce the lint issues locally. This will educate PR authors on how to run lint and fix the issues without unnecessarily spamming the PR with 50+ comments, while still providing useful reviews to authors when only a handful of lint issues slip by. * Code moved to `bots/` directory for ease of discovery and co-location with pull-bot. * Added `yarn lint-ci` command. This seems like the right choice: it's running `yarn lint` and other linters, and it is only intended to run on CI. * It's still possible to run `yarn lint-ci` locally, though the script will stop short of posting a review to GitHub unless the necessary envvars are provided. * Added `yarn shellcheck` command. This can be run locally, though it requires `shellcheck` to be installed. * Outside of this PR, I added instructions on using shellcheck to https://github.com/facebook/react-native/wiki/Development-Dependencies * Updated Circle CI config to use these new commands, and streamlined the `analyze_pr` step. * Documented analysis-bot in `bots/README.md`. ### pull-bot * Bumped `danger-js` dependency. No breaking changes found in this minor bump from what I can tell. * Documented pull-bot in `bots/README.md`. ### misc * PR template: don't use jargon. ## Changelog [Internal] [Changed] - GitHub Bots cleanup Pull Request resolved: https://github.com/facebook/react-native/pull/24923 Differential Revision: D15399744 Pulled By: hramos fbshipit-source-id: 32632e775f8554424072270e3f98542de84bfb8c
2019-05-22 02:35:40 +00:00
<!-- Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes the user interface. -->
Reference in New Issue Copy Permalink