Details
-
Type: Task
-
Status: Pull Request Submitted (View Workflow)
-
Priority: Major
-
Resolution: Unresolved
-
Affects Version/s: None
-
Fix Version/s: None
-
Labels:
-
Story Points:2
-
Epic Link:
-
Sprint:Fall 2018 Sprint 5, Winter 2018 Sprint 1, Winter 2018 Sprint 3, Spring 2019 Sprint 1, Spring 2019 Sprint 2, Summer 2019 Sprint 7, Summer 2019 Sprint 8, Summer 2019 Sprint 9, Fall 5 : 14 Oct to 25 Oct, Fall 6 : 28 Oct to 8 Nov, Fall 7 : 11 Nov to 22 Nov, Fall 8 : 25 Nov to 6 Dec, Spring 9 : 25 May to 8 Jun, Summer 3: 6 Jul - 17 Jul, Summer 4: 14 Jul - 28 Jul, Summer 6: 17 Aug - 28 Aug, Summer 7: 31 Aug - 11 Sep, Fall 3: Oct 12 - Oct 23, Winter 5 Feb 22 - Mar 5, Winter 6 Mar 8 - Mar 19, Spring 4 2021 May 3 - May 14, Spring 5 2021 May 17 - May 28, Summer 2 2023 May 29, Fall 4 2023 Oct 16, Spring 2, Spring 5, Fall 1, Fall 5
Description
The main goal of this ticket/issue is for you to practice the IGB workflow using Jira.
You'll make a small change to the code base, test it, and then move your ticket forward in the board.
To start, download and run IGB. Then, Select Help > About Integrated Genome Browser.
Note there is a list of contributors. For this task, add your name to the list.
Note:
- Assign this issue to yourself, and move it into the current spring to the "In Progress" lane.
- Read and review the comments and previous work done by others. Review the comments and history for the linked issues, as well.
- Work on editing the proper section of code and adding your name to the credits. Use the IGB fork-and-branch workflow.
- Once you've completed the code changes, run a successful pipeline, and commented a link to your branch, moved this ticket to the "Needs first level review" column, and unassign yourself.
Reminders and tips:
- Make sure your installer has built (as seen in your downloads section). Whoever does the functional review will download and run your installer.
- Make sure you add a link to your fork and branch as a comment to the issue. Whoever does code review will need the link to find your fork and view your code.
- Use correct voice and format for commit messages.
Reviewers:
- Check that the installer has built.
- Check that all commit messages contain the ticket number.
- Check that commit messages are imperative voice, present tense.
- Check that the ticket contains a link to the fork.
- Check that only one line of code is changed (no whitespace edits).
Attachments
- Addname.png
- 69 kB
- Addname.png
- 80 kB
- contributor_charan.PNG
- 337 kB
- HelpPage_1464.PNG
- 40 kB
- NameonIGB.PNG
- 58 kB
- screenshot-1.png
- 56 kB
Issue Links
- blocks
-
IGBF-2125 On-boarding: Step 5 - Learn OSGi basics from OSGi in Action text
- In Progress
- is blocked by
-
IGBF-1764 On-boarding: Step 2 - fork IGB team repository and set up bitbucket pipelines to build installers
- Closed
-
IGBF-1573 On-boarding: Step 3 - get familiar with IGB workflow and git
- Closed
- is cloned by
-
IGBF-2412 CLONE - On-boarding: Step 4 - add your name to Credits
- Closed
- relates to
-
IGBF-1572 Add your name to Credits
- Closed
-
IGBF-1738 Add your name to Credits
- Closed
-
IGBF-1347 Add your name to credits in About IGB window
- Closed
Activity
Revise commit message.
Begin with JIRA issue (as you did - good!) but use imperative mood.
Quoting a useful blog post on this topic:
start quote
A properly formed Git commit subject line should always be able to complete the following sentence:
If applied, this commit will [insert your subject line here]:
For example:
If applied, this commit will "Add auth to X"
Notice how this doesn’t work for the other non-imperative forms:
If applied, this commit will "added auth to Y"
end quote
(from https://code.likeagirl.io/useful-tips-for-writing-better-git-commit-messages-808770609503)
Updated the commit message and the changes are ready for review.
Commit message should use imperative voice.
Please see recent commit messages written by me as examples.
Updated with comment "IGBF-1464: Add name Pawan Bole to credits"
Ready for pull request.
Merged to master branch. Ready for testing.
Steps For Testing:
1. Downloaded Latest merged Master branch executable file.
(IGB-master-x64.exe) date : 2018-11-28
2. installed IGB -> Help ->About Integrated Genone Browser and checked that Pawan Bole is part of Contributor's List
Check attached screen Shot 'HelpPage_1464'
Testing Evidence
Please add link to your fork/branch. Thanks!
Link to Charan Fork and Branch(Adding name in the help section)
link : https://bitbucket.org/svallapu/charan_igb_fork/branch/IGBF-1464
When you move a story into a review column, change the assignee to "Unassigned" so that others can easily see no-one is currently working on it and it's ready for someone to review.
Go ahead and do that for the next steps.
Please see comment on branch.
IGBF-1464 Added charan name to the About IGB Section.
Updated Branch(New Fork) link : https://bitbucket.org/svallapu/charan_igb/branch/IGBF-1464
Problem: All the lines are altered when commit is made through windows machine.
Solution: Changing the line ending setting in the git solves the problem.
Command: git config --global core.autocrlf true
Moved to Ready for Pull Request column.
Steps for testing:-
1) Download the latest merged Master branch IGB executable file. (IGB-master-x64.exe) date - 01/10/2019
2) Install IGB application.
3) Once the application opens click Help --> About Integrated Genome Browser.
4) Check that Sai Charan Reddy Vallapureddy is the part of Contributors list.
Please check the attached screenshot contributor_charan.png
Done with coding. Unit testing in progress.
Please review my changes:-
Issue - To add developer (Riddhi and Jill) names to the Contributors List on About Page
Files Changed - core\igb\src\main\resources\help\org.lorainelab.igb.AboutIGB.html
Commit Link - https://bitbucket.org/rpatil14/riddhifork-igb/branch/IGBF-1464
Code & commit message are good.
However, looks like branch is one commit behind master. (See message displayed on https://bitbucket.org/rpatil14/riddhifork-igb/branch/IGBF-1464)
Please rebase topic branch on master branch for cleaner commit history.
Then move issue back to "Needs 1st Level Review" column.
Re-based topic branch on master branch.
Pull request merged.
Recruit help from Mac and Linux users to test on those platforms.
I have added Karthik Raveendran to the Credits
https://bitbucket.org/KarthikRavee91/karthikfork-igb/branch/IGBF-1464
Please add full stop after name.
change to "Karthik Raveendran" to "Karthik Raveendran."
Changes have been made and issue moved to 1st level review
Almost done!!
Please modify commit message to use imperative voice, present tense.
For details, see:
https://canvas.instructure.com/courses/1164217/pages/learn-git-getting-started?module_item_id=12709537
Follow link labeled "How to write a commit message"
Summary:
Write the commit message as though you are giving an order to the code base.
Also, if working on the IGB code base, please start with Jira issue identifier.
Hypothetical example:
- IGBF-9023 Make me a sandwich
Almost there!
Changes the comment to imperative voice: "Add Karthik Raveendran to the Credits"
Please submit pull request.
The name is added to the credits. Test successful.
I have added my name to the credits.
The bitbucket link to the same : https://bitbucket.org/nzahara/integrated-genome-browser-local/branch/IGBF-1464#diff
Sameer Shanbhag - Kindly review the code and let me know if I can submit a pull request.
The code seems to be fine. Can be moved to Ready for the pull request.
I have created a pull request . https://bitbucket.org/lorainelab/integrated-genome-browser/pull-requests/694/igbf-1464/diff
[~aloraine] - Kindly approve.
Merged to master.
I have added my name to the credits. The link is as follows:
https://bitbucket.org/sgk27/shamika-igb/branch/IGBF-1464#diff
https://bitbucket.org/sgk27/shamika-igb/pull-requests/2/igbf-1464-add-shamika-kulkarni-to-the/diff
I have created a pull request.
Kindly approve.
Pull request needs to be for merging into master branch of the team repository, not master branch of the fork.
Need to submit pull request from your fork's branch to the team repository's master branch. Current pull request is for your fork, not the team repo.
Shamika: need to issue pull request from your branch on your fork to master branch on team repo.
Made the necessary changes for the pull request.
SGK: Please review "The seven rules of a great Git commit message" in https://chris.beams.io/posts/git-commit/
Please note: item 4.
When that is done, please move this ticket to "Done" column.
Pull request merged to master. SGK added to credits.
Reviewed the link. Moving the ticket to "Done" column. Thank you for the link.
Please review the following branch on my fork:
https://bitbucket.org/pbadzuh/igb_pb_fork/branch/IGBF-1464-AddToCredits#diff
Code is fine. Installers are build and copied to Downloads section.
Returning JIRA card to Needs First Level Review for next step - functional review.
Prutha Kulkarni - when you get a minute could you do the functional review?
Sure ma'am.
Philip Badzuh, functionality is working fine. The name has been added to the credits section.
Please go ahead and submit a PR for the same.
Thanks.
I have submitted a pull request here:
https://bitbucket.org/lorainelab/integrated-genome-browser/pull-requests/742/add-philip-badzuh-to-credits/diff
Merged and master branch installer is built and ready for testing. Also, deployed as early release installer to https://bioiviz.org.
Please test by installing and running early release version for each platform.
Philip's name is present in the credits. Also, when tested I observed that the link to early releases was generating an error. Moving the ticket to To-do. Kindly check.
Thank you for noticing this error.
I have updated https://Bioviz.org with new (hopefully correct) link to Windows installer.
Please review Shamika Gajanan Kulkarni.
I have tried installing IGB through early access link on https://www.bioviz.org. I was able to download and install from this link. The early release version has a commit id of a commit made 5 days ago. There are 5 commits made after this particular commit. Please let me know if this is fine and I shall move the ticket forward. Thank you.
Please download and check again
It looks fine now. Should I move the ticket to Closed? Thank you for fixing it.
Please review my changes : Added my name to the credits
Link to branch : https://bitbucket.org/pnikhare/integrated-genome-browser/branch/IGBF-1464#diff
Please review my changes : Added my name to the credits
Link to branch : https://bitbucket.org/pnikhare/integrated-genome-browser/branch/IGBF-1464#diff
Please check settings on the repository. I think it is probably set to "private". Please change to "public".
changed my repository settings to public repository
Take a look at the commits on your branch. Can you squash these to just one commit to give a simpler commit history?
Please use the final commit message - I think it is the better one.
Please review my changes in the branch.
Link to branch : https://bitbucket.org/pnikhare/integrated-genome-browser/branch/IGBF-1464#diff
Please submit PR
Tested the ticket. Pooja's name is visible in the Credits. Moving to closed.
Name is added to the credits.
Fork, Branch, and Commit link:
https://bitbucket.org/Rweidenh/integrated-genome-browser/branch/IGBF-1464
Logan Weidenhammer please note:
Ticket is in "Ready for Pull Request" column. No notes have been added explaining what testing and code reivew was done by the reviewer (Nowlan Freese). For very lightweight changes such as this, it's fine to not add any notes regarding the review. However, it's best practice to say something like:
"Functional testing and code review is complete." and then describe testing procedures.
Tested master branch.
Rachel Weidenhammer shows up in credits.
Chirag Chandrahas Shetty - this ticket is in the next sprint. If you are able to finishing "On-boarding Step 3" then feel free to pull this into the current sprint.
Please review the changes.
link: https://bitbucket.org/chirag06/integrated-genome-browser/branch/IGBF-1464#diff
Change request: Please review the workflow lessons regarding changing assignee after moving the tickets forward.
Code review is fine!
Shamika Gajanan Kulkarni - could you do functional review?
Yes Dr. [~aloraine] I will do it
Functional review completed for this ticket. Chirag Chandrahas Shetty's name is visible in the list of contributors.
Chirag Chandrahas Shetty please submit a PR for the same.
Pull request link: https://bitbucket.org/lorainelab/integrated-genome-browser/pull-requests/811
A request:
Could you submit the requested change in one single commit affecting org.lorainelab.igb.AboutIGB.html only?
Merged and moved forward on the board to "Needs Testing"
Testing using master branch installer.
[~aloraine] Chirag's name is not visible using the master branch installer, however it does appear when cloning the repository and running it on NetBeans.
When opening the AboutIGB page after running the installer from master.exe of https://bitbucket.org/lorainelab/integrated-genome-browser/ , the following is shown:
The current Branch Name : master
The build date/time : 07-22-2020 13:50:55
The latest commit id : 6b64faa6bad4597b8bbe32e87059e258407e80ae
The latest commit stated above is the commit that was merged before Chirag's commit.
Thank you for noticing this.
I have just now manually triggered the "master branch installer" pipeline.
We to need to investigate how I can get this to happen automatically on the team repository. I am not sure exactly how to do that from the bitbucket side of the things but will look into it.
cc: Jay Chamma
Chirag Chandrahas Shetty, your name has been added to the credits.
Moving the ticket to Done.
Added my name to credits and requesting 1st level review.
My fork link: https://bitbucket.org/supreeth27/integrated-genome-browser/src/master/
Sai Supreeth Segu - Kindly check your pipeline configuration. I am unable to view the installers for all the platforms under downloads.
Also specify the ticket number in the commit.
I have fixed the issue. Please review it now.
Link for my fork: https://bitbucket.org/supreeth27/integrated-genome-browser/src/master/
Sai Supreeth Segu Kindly remove commit number cd4c191 from your history. You can do that using git rebase in interactive mode on your main branch and delete that particular commit.
Please review my changes:
My branch link: https://bitbucket.org/supreeth27/integrated-genome-browser/src/IGBF-1464/
Looks good to me.
Shall I submit a pull request for this?
cc: Noor Zahara
Sai Supreeth Segu - Yes, you can.
submitted pull request https://bitbucket.org/lorainelab/integrated-genome-browser/pull-requests/825/igbf-1464-add-name-to-credits
cc: Noor Zahara [~aloraine]
Merged. Master branch installers built.
[~aloraine], I don't understand the statement
"Assign this issue to yourself, and move it into the current spring to the "In Progress" lane."
What does the word "spring" mean here? Is it current sprint?
Otherwise instruction revisions are complete.
Added name to credits and moved task to 1st-level review
Fork link: https://bitbucket.org/Inaylor01/integrated-genome-browser/src/IGBF-1464/
The changes look good to me.
Irvin Naylor - You can submit a pull request.
Pull Request submitted: https://bitbucket.org/lorainelab/integrated-genome-browser/pull-requests/840/igbf-1464
Two change requests:
- The first two commits on the branch are not needed. Please remove them. You can do it by rebasing. Review "Learn git branching" section on interactive rebasing. Also, to remove the pipelines configuration commit, ask for some assistance from Chirag Chandrahas Shetty.
- Use imperative voice not first person past tense in git commit messages. Review: https://chris.beams.io/posts/git-commit/
For example:
is good: IGBF-1234 Improve comments
is not good: IGBF-1234 Added comments
Irvin Naylor - if you are working on this now (Friday) please move to "In Progress".
Irvin Naylor - tested on master 9.1.6 dmg installer on Mac. Can see Irvin Naylor in credits.
Change to the code base has been made. Name has been added to the credits. Please check below link. Ticket is under first level review.
https://bitbucket.org/omarne/integrated-genome-browser/src/IGBF-1464/
Tested using Omkar's branch IGBF-1464.exe download. His name did indeed show up in the credits.
It seems however another file might have been caught up in the commit, a nbactions.xml file. It seems to just have some kind of record of when he built the project using the maven command. Was curious to get another set of eyes on this.
Correct. The Netbeans xml configuration file should not be included in the commit.
Reverted the last commit, edited the file and pushed the changes. nbaction file has been excluded in the commit.
Tested using Omkar's branch IGBF-1464.exe download. Can confirm his name shows up in the credits.
One more change request for Omkar Marne:
Commit messages should use imperative and active voice. Please re-read: "How to write a git commit message."
in git module:
tldr:
OK: "IGBF-1234 Make me a sandwich"
Not OK: "IGBF-1234 A sandwich was made by me"
Also, see:
Amended the commit message to active voice.
The committed message is 'IGBF-1464 - Add my name to the credits'
Dr. Loraine please check.
How about: "Add Omkar Marne to credits"
Changed the commit message to 'IGBF-1464 - Add Omkar Marne to the credits'
Please review.
Confirm, everything looks good from the downloads section. Omkar's name shows up just fine.
Moving to recommend pull request.
Attn Omkar Marne: Have you submitted a PR? If yes, next step is to move the ticket forward in the queue.
I never submitted a pull request.
The ticket is in the "submit pull request" column & assigned. That means: submit a PR and move the ticket forward to "Pull Request Submitted". Please proceed when ready.
attn: Omkar Marne
Merged to the main branch. Please test using master branch installers from team repository as usual.
Can confirm, tested using the master branch installers and I see Omkar's name in the About IGB section. Not sure if we need any further testing but I will move to closed.
Link to fork and branch : https://bitbucket.org/jayostwal/integrated-genome-browser/branch/IGBF-1464-AddNameToCredits
Link to downloads : https://bitbucket.org/jayostwal/integrated-genome-browser/downloads/
Link to commit history: https://bitbucket.org/jayostwal/integrated-genome-browser/commits/
Name added to the credits. Screenshot Attached
Each commit should contain the IGB issue string to ensure that the commits will link back properly to the Jira board. Please revise the commits accordingly.
See: https://bitbucket.org/jayostwal/integrated-genome-browser/commits/ and note how the commits are not getting rendered with linked issue key.
Also, please note that there needs to be a space character separating the comma character and "J" in the actual change to the code.
Lastly, please update your fork's main (master) branch using the following recommended workflow:
1) Add the team repository as a new remote to your clone (on local) as alias "upstream" (the convention)
2) Switch to the main development branch (master) on your clone (on local)
3) Pull the latest master branch changes from upstream (team repo) to update your fork's copy of the master branch
4) Push the master branch changes from your clone up to your fork, which by default is a remote repository with alias "origin"
Then make sure your new branch originates from the last, most recent commit on the master branch.
Note that if you update your fork using the Web interface, a new merge commit will get added to the history of the master branch, which clutters our project with superfluous commits. If you instead use the workflow described above, the extra merge never happens.
The screen capture image is very tiny and hard to read at the default rendering for a Web browser. Replace with a nicer-looking screenshot so that it is possible to read the text without changing the browser magnification.
[~aloraine] I have made the required changes as suggested. Please ignore my previous commits as I was exploring workflow on bitbucket. I am attaching the screenshot again for your reference. The IGB browser on windows is displaying fonts very small due to some reason, I have tried to take a good visible version of it, please review and let me know if the information is visible.
- Jay's Installers have built properly.
- Commits do contain the ticket number and correctly link back to the relevant issue.
- Jay's commit message for 1464 is in the correct present-tense imperative form.
- The correct code change shows up and has no extra white space.
In addition, the new screenshot is much better and easier to read as well. Recommending Pull Request if everything looks good.
Merged and built master branch installers. Ready for testing.
Tested on mac with master installer.
Jay Ostwal appears as a contributor.
Closing issue.
ready for first level review:
https://bitbucket.org/kaushik-gopu/kgopu_integrated-genome-browser/commits/3471cb6d8e832c1929548c55a5323f254e68a2f9
Tested installer, IGB is running and includes Kaushik's name.
Ready for pull request.
PR merged and master branch installers are built and available for download from https://bitbucket.org/lorainelab/integrated-genome-browser/downloads/.
Ready for testing.
To test, install the new version as usual and confirm that Kaushik's name now appears in Help > Credits.
Installed IGB from master, Kaushik's name appears under the Credits.
I have added my name and committed it, ready for first-level review:
https://bitbucket.org/jaya-sravani/integrated-genome-browser/commits/db575ff133294876bc66a247fced6d70bc7b0109
Jaya Sravani Sirigineedi review:
- The installer is built.
- Commit messages contain the ticket number.
- The ticket contains a link to the fork.
- Only one line of code is changed (no whitespace edits).
Note: Please add a period (full stop punctuation) at the end of the contributors after you name.. Some of the previous commits did not have that because the period went missing from https://bitbucket.org/lorainelab/integrated-genome-browser/commits/014f852d84e1d5b488655491f349329578daea34
Added the period, below is the updated commit. ready for review:
https://bitbucket.org/jaya-sravani/integrated-genome-browser/commits/11abe5104b631339e6a49059fca162d944a87841
Code & commit looks good and ready for PR
Pull request submitted:
https://bitbucket.org/lorainelab/integrated-genome-browser/pull-requests/952
PR is merged to main-JDK8 branch. Installers are built and deployed to https://bitbucket.org/lorainelab/integrated-genome-browser/downloads/.
Ready for testing.
Installer worked correctly, I can see Sravani's name in About IGB.
Closing ticket.
Here is the commit for my branch, ready for review: https://bitbucket.org/pkulzer-lorainelab/integrated-genome-browser/commits/cb51a2a674d68e07d0e2baf7d9bf3e4e9662aa78
Tested with Nowlan, was successful.
Pull request submitted: https://bitbucket.org/lorainelab/integrated-genome-browser/pull-requests/981
PR is merged and installers are built. Ready for testing.
Tested on Mac, can see Paige Kulzer in the About Ingegrated Genome Browser window.
Closing ticket.
Since Dylan Marrotte is going to be doing data analysis rather than IGB software development, I think it would be better for you to do tasks from the "learn the basics - data analysis" epic.
Un-assigning and moving to DONE.
Sorry for the confusion!
Re-opened this ticket to add Dylan Marrotte's name to the credits.
Branch: https://bitbucket.org/pkulzer-lorainelab/integrated-genome-browser/branch/IGBF-1464?dest=lorainelab%2Fintegrated-genome-browser%3Amain
PR: https://bitbucket.org/lorainelab/integrated-genome-browser/pull-requests/1033
PR merged. New installers are built and deployed to BioViz Early Access section.
I've installed the newest Early Access version of IGB and confirmed that Dylan's name is now listed in the credits. Closing this ticket.
Added my name in contributors list and pushed the changes to fork repo.
I tested the changes by running the bitbucket pipeline for that particular branch and installed the .exe from downloads folder and ran the application. I am able to see my name in the contributors list.
Attaching the screenshot for verification.
Please verify the commit :https://bitbucket.org/lorainelab_udaya/integrated-genome-browser/commits/a6d8046fb8dc339f4654128e14082b35a119d9f2
Link for download folder: https://bitbucket.org/lorainelab_udaya/integrated-genome-browser/downloads/
Review:
Ran IGB with the provided installer, I can see the name added to the credits. Commit has only the required change and has a concise commit message. Moving to Pull Request.
Moving the ticket to Pull request submitted.
PR : https://bitbucket.org/lorainelab/integrated-genome-browser/pull-requests/1052
Please review my changes:
https://bitbucket.org/pawanbole/integrated-genome-browser-pawan/branch/IGBF-1464#diff