Skip to content

Commit

Permalink
Update contributing info to ssh methods
Browse files Browse the repository at this point in the history
  • Loading branch information
allevin committed Mar 16, 2021
1 parent c339ed7 commit a941ced
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@

* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/sstsimulator/sst-macro/issues).

* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/sstsimulator/sst-macro/issues/new). Be sure to include:
* A **title and clear description**
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/sstsimulator/sst-macro/issues/new). Be sure to include:
* A **title and clear description**
* As much relevant information as possible
* A **code sample** or an **executable test case** demonstrating the unexpected behavior.

---

#### **Forked Development**
Expand All @@ -41,7 +41,7 @@ my fork of that repo is here:
The way to create your own fork is to click the fork button in the upper right while you are at the official repo. Once you have done that you can simply clone

```
git clone https://github.com/fryeguy52/sst-macro
git clone git@github.com:fryeguy52/sst-macro.git
```

##### Getting updates from the official repo to your local clone
Expand All @@ -50,18 +50,18 @@ Your fork will not automatically get updates from the official repo but you will

```
git checkout devel
git remote add sst-official https://github.com/sstsimulator/sst-macro
git remote add sst-official git@github.com:sstsimulator/sst-macro.git
git pull --all
git branch devel --set-upstream-to sst-official/devel
```
You can verify that things are setup correctly

```
git remote -vv
origin https://github.com/fryeguy52/sst-macro (fetch)
origin https://github.com/fryeguy52/sst-macro (push)
sst-official https://github.com/sstsimulator/sst-macro.git (fetch)
sst-official https://github.com/sstsimulator/sst-macro.git (push)
origin git@github.com:fryeguy52/sst-macro.git (fetch)
origin git@github.com:fryeguy52/sst-macro.git (push)
sst-official git@github.com:sstsimulator/sst-macro.git (fetch)
sst-official git@github.com:sstsimulator/sst-macro.git (push)
git branch -vv
devel be1b790 [sst-official/devel: ahead 82, behind 61] Merge pull request #496 from sstsimulator/devel
Expand Down Expand Up @@ -112,7 +112,7 @@ git fetch --all --prune

#### **Patches to existing code to fix an issue**

* Create a `issue-fix` branch on your forked repo derived from the **sst-macro/devel** branch
* Create a `issue-fix` branch on your forked repo derived from the **sst-macro/devel** branch
* Make all required changes to correct the issue. All the changes must be commited to the `issue-fix` branch.
* Open a new GitHub pull request from the `issue-fix` branch to the **sst-macro/devel** branch.
* **CRITICAL: ENSURE THAT PULL REQUEST IS TARGETED TO THE `sst-macro/devel` BRANCH.**
Expand All @@ -125,7 +125,7 @@ git fetch --all --prune

#### **New Feature**

* Create a `new-feature` branch on your forked repo derived from the **sst-macro/devel** branch
* Create a `new-feature` branch on your forked repo derived from the **sst-macro/devel** branch
* Make all required changes to implement the new feature(s). All the changes must be commited to the `new-feature` branch.
* Open a new GitHub pull request from the `new-feature` branch to the **sst-macro/devel** branch.
* **CRITICAL: ENSURE THAT PULL REQUEST IS TARGETED TO THE `sst-macro/devel` BRANCH.**
Expand All @@ -138,11 +138,11 @@ git fetch --all --prune

#### **SST AutoTester (CI Testing)**

* When a Pull Request is created against the **sst-macro/devel** branch, the SST AutoTester application will automatically run (usually within 30 minutes) and will build and test the source branch of the Pull Request.
* When a Pull Request is created against the **sst-macro/devel** branch, the SST AutoTester application will automatically run (usually within 30 minutes) and will build and test the source branch of the Pull Request.
* Testing is performed across a number of different platforms
* If the test suites pass, then the Pull Request will be setup for manual merging by SST-Macro staff.
* The testing is not all inclusive, it is possible for a bug related to a specific platform to slip in. See Nightly Testing below.

---

#### **Nightly Testing**
Expand Down

0 comments on commit a941ced

Please sign in to comment.