Skip to content

Working together using GitHub

This section takes you through the process of setting up a shared project on GitHub.

  1. Choose one student to be the project owner (PO)
  2. PO: Set up the GitHub repo for the students/modules application
  3. Team: Delete existing projects and recreate them from the new repo
  4. PO: Create a project README file and documentation folder and push to GitHub
  5. Team: Update project by pulling the README from GitHub
  6. Team:
    1. Create a feature branch
    2. Add a page of documentation
    3. Commit and push
    4. Create a pull request
  7. PO: Perform merge operations as necessary
  8. Team:
  9. Make a minor change to the README file
  10. Commit and push
  11. Create pull request
  12. PO: Perform merges as required and resolve conflicts

========== Content below needs to be updated

Connecting your PyCharm environment to GitHub

How to connect github in pycharm environment

1 Before starting the work install git(offline ) into your pc.

2 Go to github and sign up page Github GITHUB_1

3 In github in the code tab click the master branch dropdown and create new branch GITHUB_2

4 In the dropdown select the branch which is created new and copy the URL under "CODE" dropdown GITHUB_3

5 Open pycharm application in your PC and click on VCS-> get from version control paste the URL link copied from the Github into the URL input tab on url After pasting the URL click CLONE to clone the project from github to the local pycharm application. GITHUB_4

6 Click on VCS->Git-> choose the newly created branch. GITHUB_5

7 In the right bottom you will find the master branch is selected ,click on that and select your newly created branch and then press checkout.

8 Update anything in your index.md file and the press commit button which is at the right-hand-top row or VCS->Commit.

After that, press the push button which is next to it so that the file is copied into GUTHUB repository which means that the GITHUB and Local repositoryis in sink. the data sink with github. GITHUB_6

PyCharm commit options

To make your commits go smoothly, enable the options to clear the initial commit message and to require a commit message as shown below:

PyCharm commit options