Skip to content

Commit 6ae8298

Browse files
authored
docs: steps to open a PR (PSKD-1751) (#159)
Signed-off-by: Ian Dominno <[email protected]>
1 parent f549ab7 commit 6ae8298

File tree

1 file changed

+92
-0
lines changed

1 file changed

+92
-0
lines changed

CONTRIBUTING.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,98 @@ All submissions to this project—including submissions from project members—r
1111
review. Our review process typically involves performing unit tests, development
1212
tests, integration tests, and security scans.
1313

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

16108
### Conventional Commits

0 commit comments

Comments
 (0)