1. Ultrasound File Format Avatar Ultrasound File Format
  2. UFF
  3. UFF

Wiki

Clone wiki

UFF / help / Getting started with UFF and BitBucket

View History

Getting started

If you have experience with git, issue trackers and pull requests; then this is not for you.

Here we include a basic introduction to git and bitbucket's interface for those using it for the first time. They take the form of step-by-step tutorial, because that's the fastest way to get things going. Feel free to follow the steps as stated and submit a dummy issue and a dummy pull request. You won't break anything, don't worry, and we will remove this dummy test regularly.

These steps are not the only way of interacting with the UFF repository, but you can use this tutorial as guidance for your workflow until you get more confident with the available tools, and procedures. We don't expend time explaining the concepts. If you have doubts on what we mean by terms such as repository, clone, git, commit, issue or pull request; then please use a few minutes to get a good grasp on those.

Step 1: Get SourceTree

  • Go to sourcetreeapp.com and download SourceTree: a free Git client for both Windows & Mac. For unix systems you may try git extensions.
  • Install your client
  • Launch it, click on the Remote button (cloud icon), and you should see a screen like this.

1.png

  • Click on Add account (plus icon), and you should see a window like this

2.png

  • Choose Bitbucket hosting service, and write your username & password (you may need to select "Basic" in the Authetication combobox)
  • Once successfully logged you should see you username on the left column

3s.png

Step 2: Clone the UFF repository

  • In the same screen of the previous step, write UFF in the Search line edit and press Enter. You should see the UFF repository showing up in the list below the line edit.

4.png

  • Click on the "Clone" link to the right of the UFF repository and the following window will be displayed

5.png

  • After some time you'll have a copy of the UFF repository in your machine. Go to the repository local folder and you should see the UFF API for you to try.

Step 3: Test MATLAB examples

  • Add the working folder into MATLAB's path
  • go to the folder examples and test the examples

Step 4: Open an issue in Bitbucket

  • Let's pretend you found a bug either in the API or in the UFF format definition, or that you simply want to ask a question, or discuss something with the rest of the task force.
  • Go to the UFF issue tracker in bitbucket. You will see a list of the open issues and a button with the label Create issue. Click it.

create_issue.png

  • The following form will be shown. You should include as much information as possible, all fields are important.

issue.png

  • Write:

    1. A short title for your issue
    2. A description of the problem, as detailed as possible. If possible, specify what your request it at the end.
    3. You should select an Assignee. If it is not clear who the assignee should be send it to @alfonso.r.molares and he will reassign it.
    4. You should specify the issue kind: bug/enhancement/proposal/task
    5. Select a priority: trivial/minor/major/critical/blocker
    6. Select the component UFF for issues with the UFF standard, MATLAB for issues with the MATLAB API, python for issues with the python API, and so on.
    7. Select the version of the standard in which you discovered the issue.
    8. You can also attach files, if needed.

  • Feel free to Create issue, even if this is just for testing. We can delete this issue afterwards.

Updated