Skip to content

ergm development workflow

Jump to bottom
David Hunter edited this page Nov 5, 2020 · 5 revisions

This page temporarily populated with content of EpiModel development page

The procedure for ergm will be slightly different than for EpiModel. This page is being updated accordingly and it should be ready by Nov. 5.

Initial Setup:

Fork the ergm GitHub Repository

  1. Either (a) visit https://github.com/statnet/ergm, click "Fork" near the upper right, and choose your own GitHub repository in which to fork the ergm repository; or (b) use your own local GitHub client (e.g., GitHub Desktop) to create a fork of statnet/ergm in your own GitHub repository.

Create a New Project in RStudio

  1. Open R and start a New Session (Session -> New Session)

  2. Start a New Project (File -> New Project)

  3. When the 'New Project' window appears, select 'Version Control' and then 'Git'.

  4. Enter the URL of your newly created ergm fork, usually something like 'https://github.com/MyPersonalGitHubAccount/ergm'

  5. Enter the local name of your project's directory as well as your local path where that directory should be created.

  6. Click 'Create Project'.

On-going Development

Create a New Branch

Create a new branch based off of the ergm "master" branch for each new issue/feature/enhancement.

In RStudio: In the pane with the "Git" tab (often in the upper right of the screen), click "Git" and then click "New Branch" or the purple icon in the upper right corner of the pane. Follow the directions to name the branch.

Develop and Test in R

Pull origin, Commit, Push, Pull Request, Merge

1. Pull Origin

2. Commit

3. Push

4. Pull Request

5. Merge

Clone this wiki locally