Code Development

Hadatac Branch Structure

The Hadatac GitHub consists of three main branches: Master, LESA, and HHEAR. The Master branch is our stable release code that is updated after a sprint. The other two are project branches used to develop new features and address bugs. Developers should never merge changes directly into Master.

Projects branches are updated frequently using Github's issue/pull request system. A user wishing to make a change to the codebase must create an issue on GitHub, fork the repository, make the desired changes to a project branch and submit a pull request for review on GitHub. These steps are detailed below.

Development Process

Creating an Issue

1. Goto: https://github.com/paulopinheiro1234/hadatac/issues
2. Check to see if your feature or bug already has an open issue
3. If not then create a new issue using the new issue button
4. Add a title
5. Leave a detailed description
   • For bugs include a description on how to recreate the bug
   • For features include a description on how Hadatac should behave if this feature is implemented
     • Example: https://github.com/paulopinheiro1234/hadatac/issues/152
6. Assign a person to work on the issue using the gear button
   • Leave blank if your assigning it to yourself
   • If it's not you be sure to let them know
7. Assign a label using the gear button
   • Features → enhancement
   • Bugs → bug
8. Assign a project using the gear button
   • This corresponds to the project the issue will be merged into either LESA or HHEAR
9. Click “Submit new issue”

Creating a Fork

1. Goto:
   • https://github.com/paulopinheiro1234/hadatac
2. Click the "Fork" button in the top right
3. Choose your GitHub account
4. Go to your project folder location
   • cd project_folder_path
5. Clone your fork
   • git clone https://github.com/<YourUsername>/hadatac.git
6. Install HADatAc

Code Development

1. Go to your project folder through your command line
   • cd hadatac
2. Add Hadatac Repository
   • git remote add hadatac git://github.com/paulopinheiro1234/hadatac.git
3. Develop tests for the new feature or bug
   • Create a Java class in project_folder/test
   • Denote test methods with @Test
4. Make code changes
5. List changed files
   • git status
6. Add changed files to a commit
   • git add file1 file2
   • Do not add files specific to your configuration
7. Commit files
   • git commit -m “Description of changes”
8. Backup changes to Github
   • git push
9. Run unit tests
   • sbt test
10. Repeat steps 3-10 until complete (Feature implemented/bug fixed and tests pass)
11. Merge development branch changes
    • git pull hadatac
12. Check for conflicts
    • git status
13. Resolve conflicts
14. Repeat steps 3-14 until complete (Feature implemented/bug fixed and tests pass)

Creating a Pull Request

1. Goto:
   • https://github.com/<YourUsername>/hadatac/pulls
2. Click "New Pull Request"
3. Set base using the dropdown and select the development branch
   • Should be HHEAR or LESA
4. Set compare using the dropdown and select the branch you're developing on
5. Click “Create pull request” button

6. Enter a title and detailed description
   • These will look very similar to the issue if the pull request is addressing only one issue
7. Assign a reviewer using the gear button
   • This should never be you
   • Be sure to let them know
8. Assign a label using the gear button
   • Features → enhancement
   • Bugs → bug
9. Assign a project using the gear button
   • This corresponds to the project the issue will be merged into either LESA or HHEAR
10. Select Issue addressed using the gear button

Reviewing a Pull Request

1. Double-check the pull request information
   • Don’t forget the base this should be HHEAR or LESA
2. If the pull request is ready (approved) select “Squash and merge”
   • This will convert all commits into a single commit
   • This makes exploring the git history easier to search through
3. Enter a final description for git history
4. Submit changes
   • This will merge changes and close all linked issues