Details
-
Type:
Task
-
Status: Closed (View Workflow)
-
Priority:
Major
-
Resolution: Done
-
Affects Version/s: None
-
Fix Version/s: None
-
Labels:
-
Story Points:0.5
-
Epic Link:
-
Sprint:Summer 2019 Sprint 10, Summer 2019 Sprint 11
Description
Go to https://bitbucket.org/lorainelab/genoviz-sdk/src/master/
Scroll down. Note that no "README" text is shown. That's because Bitbucket displays README.md (markdown) files in this location.
For this task, we need to include a README.md that provides basic information about the Genoviz SDK.
Add a README.md file that includes:
- brief summary of what Genoviz SDK is
- link to Pubmed record for BMC Bioinformatics paper introducing Genoviz (see Loraine Lab web site publications page for article link)
- instructions on how to build it (if not obvious)
- location of maven repository (can find it in IGB POM)
- license information (can link to license file if available)
- explanation of tutorial; warning that it is using applets and is not working
When that is done, remove README.txt
Use fork-and-branch workflow (same as with IGB)
Attachments
Activity
| Field | Original Value | New Value |
|---|---|---|
| Epic Link | IGBF-1531 [ 17617 ] |
| Rank | Ranked higher |
| Assignee | Ann Loraine [ aloraine ] |
| Assignee | Prutha Kulkarni [ prutha ] |
| Sprint | Summer 2019 Sprint 10 [ 69 ] | Summer 2019 Sprint 10, Summer 2019 Sprint 11 [ 69, 70 ] |
| Rank | Ranked higher |
| Status | Open [ 1 ] | In Progress [ 3 ] |
Included a READE.md file with
brief summary of what Genoviz SDK is
link to Pubmed record for BMC Bioinformatics paper introducing Genoviz (see Loraine Lab web site publications page for article link)
instructions on how to build it (not added because it was obvious)
location of maven repository
license information (added a license file for more information)
explanation of tutorial
The README.md file id available at:
https://bitbucket.org/lorainelab/genoviz-sdk/src/IGBF-1861/
| Assignee | Prutha Kulkarni [ prutha ] |
| Status | In Progress [ 3 ] | Needs 1st Level Review [ 10005 ] |
| Status | Needs 1st Level Review [ 10005 ] | Ready for Pull Request [ 10304 ] |
| Assignee | Prutha Kulkarni [ prutha ] |
This is good - thank you! Go ahead and submit a pull request.
I will probably add a few things once it's merged to master.
Pull request is submitted for the same.
The code changes are available at :
https://bitbucket.org/lorainelab/genoviz-sdk/pull-requests/16/igbf-1861-improve-readme-for-genoviz/diff
Prof. [~aloraine], could you please merge it into the master?
Thanks.
| Assignee | Prutha Kulkarni [ prutha ] |
| Status | Ready for Pull Request [ 10304 ] | Pull Request Submitted [ 10101 ] |
Merged and moved to Closed.
| Resolution | Done [ 10000 ] | |
| Status | Pull Request Submitted [ 10101 ] | Closed [ 6 ] |
| Workflow | Loraine Lab Workflow [ 18584 ] | Fall 2019 Workflow Update [ 20262 ] |
| Workflow | Fall 2019 Workflow Update [ 20262 ] | Revised Fall 2019 Workflow Update [ 22406 ] |
| Assignee | Prutha Kulkarni [ prutha ] |
Prof. [~aloraine], I am unable to figure out what to add in the "explanation of tutorial" section of the README file.
Could you please help me with that?