@@ -14,6 +14,98 @@ All submissions to this project—including submissions from project members—r
14
14
review. Our review process typically involves performing unit tests, development
15
15
tests, integration tests, and security scans.
16
16
17
+ ## How To Open A Pull Request
18
+
19
+ The following steps below demonstrate how to contribute to the [ viya4-iac-gcp] ( https://github.com/sassoftware/viya4-iac-gcp )
20
+ repository by forking it, making changes, and submitting a pull request (PR).
21
+
22
+ 1 . Fork the Repository
23
+
24
+ - Navigate to the [ viya4-iac-gcp] ( https://github.com/sassoftware/viya4-iac-gcp ) .
25
+ - Click the ** “Fork”** button in the upper-right corner.
26
+ - This creates a copy of the repository under your GitHub account.
27
+
28
+ ** Alternative (using GitHub CLI):**
29
+ If you have the [ GitHub CLI] ( https://cli.github.com/ ) installed, run:
30
+
31
+ ``` bash
32
+ gh repo fork https://github.com/sassoftware/viya4-iac-gcp.git --clone
33
+ ```
34
+
35
+ 2. Clone the Forked Repository Locally
36
+
37
+ ` ` ` bash
38
+ git clone https://github.com/< YOUR_USERNAME> /< REPO_NAME> .git
39
+ ` ` `
40
+
41
+ 3. Add the Original Repository as an Upstream Remote (Optional but recommended)
42
+
43
+ - To keep your fork in sync with the original [viya4-iac-gcp](https://github.com/sassoftware/viya4-iac-gcp)
44
+ repository:
45
+
46
+ ` ` ` bash
47
+ git remote add upstream https://github.com/sassoftware/viya4-iac-gcp.git
48
+ git fetch upstream
49
+ ` ` `
50
+
51
+ - To sync changes from the original repo:
52
+
53
+ ` ` ` bash
54
+ git checkout main
55
+ git pull upstream main
56
+ git push origin main
57
+ ` ` `
58
+
59
+ 4. Create a New Branch for Your Contribution
60
+
61
+ ` ` ` bash
62
+ git checkout -b my-contribution-branch
63
+ ` ` `
64
+
65
+ 5. Make Your Changes Locally
66
+
67
+ - Edit the files as needed using your preferred code editor.
68
+
69
+ 6. Stage and Commit Your Changes
70
+
71
+ ` ` ` bash
72
+ git add .
73
+ git commit -s -m " Your conventional commit message"
74
+ ` ` `
75
+
76
+ 7. Push the Branch to Your Fork
77
+
78
+ ` ` ` bash
79
+ git push origin my-contribution-branch
80
+ ` ` `
81
+
82
+ 8. Create the Pull Request (PR)
83
+
84
+ - Go to your forked repository on GitHub.
85
+ - You will see a ** “Compare & pull request”** button, click it.
86
+ - Check to ensure:
87
+ - The ** base repository** is the original [viya4-iac-gcp](https://github.com/sassoftware/viya4-iac-gcp)
88
+ repository.
89
+ - The ** base branch** is ` main` .
90
+ - The ** head repository** and ** compare branch** is correct.
91
+ - Click ** “Create pull request.”**
92
+
93
+ 9. Keep Your Branch Up to Date (If Needed)
94
+
95
+ - If the base branch has changed and you need to rebase:
96
+
97
+ ` ` ` bash
98
+ git fetch upstream
99
+ git checkout my-contribution-branch
100
+ git rebase upstream/main
101
+ ` ` `
102
+
103
+ - After resolving any conflicts, force push your changes:
104
+
105
+ ` ` ` bash
106
+ git push origin my-contribution-branch --force
107
+ ` ` `
108
+
17
109
# # Pull Request Requirement
18
110
19
111
# ## Automated Tests
0 commit comments