Repository Usage Manual - bounswe/bounswe2016group12 GitHub Wiki

Repository Usage Rules

From now on we must apply some rules on source control to keep things tidied up.

We have 4 main topics: Backend, Mobile, Web , Wiki

  • All commit messages must have a prefix with the topics listed above. For example:

    • Backend - Database updated with new field
    • Wiki - Mobile profile mockup added.
    • Web - Profile page created and basic functionality implemented.

  • There will be 4 folders with the topics above and a 352 folder for old things.

  • Each folder has its own project and related files inside it.

  • We will use Android Studio for Mobile, PyCharm for Backend and WebStorm for Web Page.

  • Each issue must have a branch with its code. Branch names are like: I-45, I-57, I-101 (I for Issue)

  • If an issue is finished (even if it is very tiny ), don't directly merge it, send a pull request into dev and describe shortly what you have done. Some other person will merge it after checking.

  • We will have a "dev" branch. Firstly we will collect new features (solved issues) into dev, then we will weekly update master from dev after testing dev for new features. This way master stays always stable.

  • Everyone is free to use their own source control software or package. ( SourceTree is a very useful suggestion)

Step-by-Step Guide

  • Go inside Projects Tab in Github, Open Meanco, and select an issue (Let's assume issue number is 104).
  • Move the issue "In progress" column.
  • Open branch "I-104" from where "origin/dev" stands.
  • Commit your changes in important points and name your commits with a Prefix. For example:
    • Backend - Database updated with new field
    • Wiki - Mobile profile mockup added.
    • Web - Profile page created and basic functionality implemented.
    • Mobile - ListView added into LoginActivity
  • When your job done commit and push all your changes.
  • Open Github, Enter "Pull Requests" tab, and Create a pull request by choosing "dev" for base and choosing "I-104" for "compare".
  • Write a brief description of what you did and open pull request, and inform group members to check it.
  • If the pull request has comments after review and they have to be handled. Go to "I-104" branch again and make the changes and commit and push.
  • Then enter the pull request page, you will see a button "Update pull request" , click on it.
  • After succesfull Merge you can delete branch "I-104" and close and move the issue into Done tab.

Checking the Pull Request

  • Review the code and if you want a change ,put a comment by using the plus sign appears when your mouse is on the line.
  • If code is good and it is written "Able to Merge" , click on "Merge" button and you are done.
  • If it says "Not able to merge, there are conflicts" , Use your IDE to resolve conflicts. (This will be a very rare situation in our project and If it happens we will solve it together.