Merge pull request Expensify#63674 from software-mansion-labs/war-in/improve-patch-guidelines

[No QA] Improve patch guidelines

Author: roryabraham

.github/ISSUE_TEMPLATE/NewPatchTemplate.md

@@ -0,0 +1,39 @@
+---
+name: Patch Tracking
+about: Template for tracking patches applied to third-party libraries
+---
+
+If you haven't already, check out our [contributing guidelines](https://github.com/Expensify/App/blob/main/contributingGuides/CONTRIBUTING.md) and [patch guidelines](https://github.com/Expensify/App/blob/main/contributingGuides/PATCHES.md) for information on how to manage patches.
+___
+
+## Patch Information
+
+**Library Name:** <!-- e.g., react-native-pdf -->
+**Library Version:** <!-- e.g., 6.7.3 -->
+**Patch Number:** <!-- e.g., 001 -->
+**Patch Description:** <!-- e.g., update-podspec-to-support-new-arch -->
+**Full Patch Filename:** <!-- e.g., react-native-pdf+6.7.3+001+update-podspec-to-support-new-arch.patch -->
+
+## Patch Details
+
+### Reason for Patch
+<!-- Explain why this patch is necessary. What issue does it solve? -->
+
+### Changes Made
+<!-- Briefly describe the changes made in the patch -->
+
+### Upstream Status
+**Upstream PR/Issue:** <!-- Link to the PR or issue in the upstream repository, if one exists -->
+
+## Related Information
+
+**PR Introducing Patch:** <!-- Link to the PR that introduced this patch -->
+
+## Additional Notes
+<!-- Any other relevant information about this patch -->
+
+## Checklist
+- [ ] Patch file is correctly named and placed in the appropriate directory
+- [ ] Patch is documented in the corresponding `details.md` file
+- [ ] This issue is linked in the `details.md` file
+- [ ] Upstream PR/issue has been created (if applicable)

contributingGuides/PATCHES.md

@@ -6,6 +6,34 @@ To ensure patches remain maintainable and traceable over time, follow the guidel
 
 ---
 
+## 🛠️ Creating a Patch
+
+To create a patch for a third-party library that you've modified:
+
+1. Make your changes to the library code in the `node_modules/<edited-library>` directory
+2. Run the following command to generate the patch file:
+
+```
+npx patch-package <edited-library> --append "<short-patch-description>" --patch-dir ./patches/<edited-library>
+```
+
+For example:
+```
+npx patch-package react-native-pdf --append "fix-pdf-rendering-on-ios" --patch-dir ./patches/react-native-pdf
+```
+
+This will create a patch file in the `patches/` directory. After creating the patch:
+
+- Create or update the `details.md` file in the library's patch directory
+- Document the patch according to the [`details.md` format](#-detailsmd-format)
+
+> 📝 **Note**
+>
+> The `--patch-dir` option should only be specified when the target library has a dedicated subdirectory within the `./patches` directory.
+> If no such subdirectory exists, omit this option from the command.
+
+---
+
 ## 🗂️ Folder Structure
 
 Each library with patch (or patches) should have its own directory inside `patches/`. Each directory should contain:
@@ -54,23 +82,34 @@ Each patch must be listed and explained in the `details.md` file within the same
 
 ### [<patch-name>.patch](<patch-name>.patch)
 
-- Reason: <Why this patch is needed>
-- Upstream PR/issue: <link or 🛑 if not raised. If no upstream issue or PR exists, explain why>
-- E/App issue: <link or 🛑 if none>
-- PR Introducing Patch: <link to internal PR that added the patch>
+- Reason:
+  
+    ```
+    Please explain why the patch is necessary
+    ```
+  
+- Upstream PR/issue: <Please create an upstream PR fixing the patch. Link it here and if no upstream issue or PR exists, explain why>
+- E/App issue: <Please create an E/App issue ([template](./../.github/ISSUE_TEMPLATE/NewPatchTemplate.md)) for each introduced patch. Link it here and if patch won't be removed in the future (no upstream PR exists) explain why>
+- PR introducing patch: <Link to E/App (or Mobile-Expensify) PR that added the patch>
 ```
 
 ### Example
 
 ```md
 # `react-native-pdf` patches
 
-### [react-native-pdf+6.7.3+002+fix-incorrect-decoding.patch](react-native-pdf+6.7.3+002+fix-incorrect-decoding.patch)
+### [react-native-pdf+6.7.3+001+update-podspec-to-support-new-arch.patch](react-native-pdf+6.7.3+001+update-podspec-to-support-new-arch.patch)
+
+- Reason:
+
+    ```
+    This patch updates the react-native-pdf.podspec to ensure compatibility with React Native's New Architecture on iOS by replacing manual dependency declarations
+    with Meta's recommended `install_modules_dependencies` function
+    ```
 
-- Reason: If the file name contains accented characters, the PDF load fails.
-- Upstream PR/issue: 🛑
-- E/App issue: 🛑
-- PR Introducing Patch: [#50043](https://github.com/Expensify/App/pull/50043)
+- Upstream PR/issue: https://github.com/wonday/react-native-pdf/pull/803
+- E/App issue: 🛑 TODO
+- PR Introducing Patch: https://github.com/Expensify/App/pull/13767
 ```
 
 ## ✅ Patch Submission Checklist

patches/react-native-pdf/details.md

@@ -1,8 +1,14 @@
 # `react-native-pdf` patches
 
-### [react-native-pdf+6.7.3+001+initial.patch](react-native-pdf+6.7.3+001+initial.patch)
+### [react-native-pdf+6.7.3+001+update-podspec-to-support-new-arch.patch](react-native-pdf+6.7.3+001+update-podspec-to-support-new-arch.patch)
+
+- Reason:
+
+    ```
+    This patch updates the react-native-pdf.podspec to ensure compatibility with React Native's New Architecture on iOS by replacing manual dependency declarations
+    with Meta's recommended `install_modules_dependencies` function
+    ```
 
-- Reason: Explanation/details
 - Upstream PR/issue: https://github.com/wonday/react-native-pdf/pull/803
 - E/App issue: 🛑
-- PR Introducing Patch: [#13767](https://github.com/Expensify/App/pull/13767)
+- PR Introducing Patch: https://github.com/Expensify/App/pull/13767

…react-native-pdf+6.7.3+001+initial.patch …update-podspec-to-support-new-arch.patchpatches/react-native-pdf/react-native-pdf+6.7.3+001+initial.patch renamed to patches/react-native-pdf/react-native-pdf+6.7.3+001+update-podspec-to-support-new-arch.patch patches/react-native-pdf/react-native-pdf+6.7.3+001+initial.patch renamed to patches/react-native-pdf/react-native-pdf+6.7.3+001+update-podspec-to-support-new-arch.patch

@@ -1,16 +1,25 @@
 # `react-native-tab-view` patches
 
-### [react-native-tab-view+4.1.0+001+initial.patch](react-native-tab-view+4.1.0+001+initial.patch)
+### [react-native-tab-view+4.1.0+001+fix-tab-animation.patch](react-native-tab-view+4.1.0+001+fix-tab-animation.patch)
 
-- Reason: Explanation/details
-- Upstream PR/issue: N/A
-- E/App issue: https://github.com/Expensify/App/issues/38796 | https://github.com/Expensify/App/issues/39285
+- Reason: 
+
+    ```
+    This patch addresses an issue where the camera in IOURequestStepScan fails to render due to the current position value
+    from react-native-tab-view not updating during tab transitions. It explicitly trigger a re-render when the active tab or page changes.
+    ```
+
+- Upstream PR/issue: 🛑
+- E/App issue: 🛑
 - PR Introducing Patch: [#39854](https://github.com/Expensify/App/pull/39854)
-- PR Updating Patch: [#60468](https://github.com/Expensify/App/pull/60468)
 
 ### [react-native-tab-view+4.1.0+002+fix-glitching-on-initial-load.patch](react-native-tab-view+4.1.0+002+fix-glitching-on-initial-load.patch)
 
-- Reason: There was a visible glitching on initial load. The glitch was visible because two animated values: position and translateX were equal to 0 for a brief moment before changing to a proper value.
+- Reason: 
+    ```
+    There was a visible glitching on initial load. The glitch was visible because two animated values:
+    position and translateX were equal to 0 for a brief moment before changing to a proper value.
+    ```
 - Upstream PR/issue: https://github.com/react-navigation/react-navigation/pull/12627#issuecomment-2945055209
 - E/App issue: https://github.com/Expensify/App/issues/62346
-- PR Introducing Patch: [#63570](https://github.com/Expensify/App/pull/63570)
+- PR Introducing Patch: [#63570](https://github.com/Expensify/App/pull/63570)

patches/react-native-tab-view/details.md

@@ -48,6 +48,7 @@ done
 if [[ ${#ERRORS[@]} -eq 0 ]]; then
   echo "✅  All changed patches are valid!"
 else
+  printf "Refer to https://github.com/Expensify/App/blob/main/contributingGuides/PATCHES.md to fix following errors:\n"
   printf "%s\n" "${ERRORS[@]}"
   exit 1
 fi