Merge pull request #20 from cemitch99/update_contributing_instructions

Update CONTRIBUTING instructions, and make PR template optional.
campa-consortium · Jan 14, 2025 · e5108b1 · e5108b1
2 parents e65f7c7 + cf0f869
commit e5108b1
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 42 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_element_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_element_template.md
diff --git a/front_matter/pull_request_template.md → .github/pull_request_template.md b/front_matter/pull_request_template.md → .github/pull_request_template.md
diff --git a/front_matter/contributing.md b/front_matter/contributing.md
@@ -3,14 +3,26 @@
 Follow these steps **only once**:
 1. Go to https://github.com/campa-consortium/lattice-standard.
 
-2. Click the pulldown arrow next to `Fork`, click `Create a new fork`, and specify your GitHub username in the `Owner` field (e.g., "cemitch99").
+2. Click the pulldown arrow next to `Fork`, click `Create a new fork`, and specify your GitHub username in the `Owner` field (e.g., "username").
 
-3. Click `Code` to view and copy the URL of your fork 
-(e.g., https://github.com/cemitch99/lattice-standard.git)
+3. Go back to https://github.com/campa-consortium/lattice-standard, click `Code` > `SSH`, and copy the url of the repo:
+(e.g., git@github.com:campa-consortium/lattice-standard.git)
 
-4. On your local machine, from the terminal, clone your fork:
+The simpler option `Code` > `HTTPS` can be used if the user just want to look at the repo.  (This does not require a password setup.)
+
+5. On your local machine, from the terminal, clone the main repository:
+```
+git clone [email protected]:campa-consortium/lattice-standard.git
+```
+
+5. Rename what we just cloned:  call it "mainline":
+```
+git remote rename origin mainline
 ```
-git clone https://github.com/cemitch99/lattice-standard.git
+
+6.  Add your remote repository in order to track it locally:
+```
+git remote add username [email protected]:campa-consortium/lattice-standard.git
 ```
 
 Follow these steps **each time you submit a pull request**:
@@ -19,6 +31,12 @@ Follow these steps **each time you submit a pull request**:
 cd lattice-standard
 ```
 
+2. Make sure your local repository is up-to-date:
+```
+git checkout main
+git pull
+```
+
 2. Create a new branch with a descriptive name for the desired changes (e.g., "add_template"):
 ```
 git checkout -b add_template
@@ -39,9 +57,9 @@ git add pull_request_element_template.md
 git commit -m "Add element template."
 ```
 
-7. Push your changes to the remote repository:
+7. Push the changes to your fork:
 ```
-git push origin add_template
+git push -u username add_template
 ```
 
 8. Follow the link that is generated to open a new pull request on GitHub that includes these changes, e.g., go to  https://github.com/cemitch99/lattice-standard/pull/new/add_template.