Forking CollaboRhythm

You may be able to extend and use CollaboRhythm by creating one or more CollaboRhythm plugins. However, if you want to make changes to any part of CollaboRhythm itself, it is recommended that you (or a member of your team) create a fork of CollaboRhythm. You can then make changes as appropriate, and you can then potentially make a Pull Request to have those changes merged into the main CollaboRhythm repository. The steps below assume you are working as part of a team, so you may need to modify the procedure slightly if you are working independently or do not want to use a GitHub organization to manage your fork of the repository.

1. Determine an appropriate name for your GitHub organization. The name should be consistent with the identity of your team/organization and must be a valid and unique GitHub organization name.

2. Decide who on your team will create and manage the fork. You generally will only want to have a single fork of the repository for your team, so the steps below only need to be performed once by one member of your team.

3. Login to GitHub (create an individual user account for yourself if you do not have one already).

4. Navigate to https://github.com/newmediamedicine/CollaboRhythm

5. Click the Fork button in the top right of the page.

6. Click the Fork to <organization_name> (organization) button.

7. Click the repository Settings button

8. Rename your forked repository appropriately, such as “CollaboRhythmMayo”. Avoid using spaces in the repository name. Renaming your repository to something other than CollaboRhythm will help to avoid confusing your copy of the repository with other copies when you or other team members are working with multiple CollaboRhythm repositories locally.

9. Add collaborators (you can repeat this process at a later time to give write access to other team members)

   a. Ensure that each team member has created a GitHub account

   b. Click the Settings button

   c. Click Collaborators

   d. For each collaborator, enter the GitHub account name you wish to add and click Add

   e. When you are done, click on Back to Source

10. Note the SSH (Read+Write access) URI for your repository, such as [email protected]:Mayo/CollaboRhythmMayo.git (you can use this to clone the repository locally; for the process below using IntelliJ you won’t need this)