Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 92 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,98 @@ All submissions to this project—including submissions from project members—r
review. Our review process typically involves performing unit tests, development
tests, integration tests, and security scans.

## How To Open A Pull Request

The following steps below demonstrate how to contribute to the [viya4-deployment](https://github.com/sassoftware/viya4-deployment)
repository by forking it, making changes, and submitting a pull request (PR).

1. Fork the Repository

- Navigate to the [viya4-deployment](https://github.com/sassoftware/viya4-deployment).
- Click the **“Fork”** button in the upper-right corner.
- This creates a copy of the repository under your GitHub account.

**Alternative (using GitHub CLI):**
If you have the [GitHub CLI](https://cli.github.com/) installed, run:

```bash
gh repo fork https://github.com/sassoftware/viya4-deployment.git --clone
```

2. Clone the Forked Repository Locally

```bash
git clone https://github.com/<YOUR_USERNAME>/<REPO_NAME>.git
```

3. Add the Original Repository as an Upstream Remote (Optional but recommended)

- To keep your fork in sync with the original [viya4-deployment](https://github.com/sassoftware/viya4-deployment)
repository:

```bash
git remote add upstream https://github.com/sassoftware/viya4-deployment.git
git fetch upstream
```

- To sync changes from the original repo:

```bash
git checkout main
git pull upstream main
git push origin main
```

4. Create a New Branch for Your Contribution

```bash
git checkout -b my-contribution-branch
```

5. Make Your Changes Locally

- Edit the files as needed using your preferred code editor.

6. Stage and Commit Your Changes

```bash
git add .
git commit -s -m "Your conventional commit message"
```

7. Push the Branch to Your Fork

```bash
git push origin my-contribution-branch
```

8. Create the Pull Request (PR)

- Go to your forked repository on GitHub.
- You will see a **“Compare & pull request”** button, click it.
- Check to ensure:
- The **base repository** is the original [viya4-deployment](https://github.com/sassoftware/viya4-deployment)
repository.
- The **base branch** is `main`.
- The **head repository** and **compare branch** is correct.
- Click **“Create pull request.”**

9. Keep Your Branch Up to Date (If Needed)

- If the base branch has changed and you need to rebase:

```bash
git fetch upstream
git checkout my-contribution-branch
git rebase upstream/main
```

- After resolving any conflicts, force push your changes:

```bash
git push origin my-contribution-branch --force
```

## Pull Request Requirement

### Conventional Commits
Expand Down
Loading