Skip to content

Latest commit

 

History

History
241 lines (160 loc) · 9.21 KB

README.md

File metadata and controls

241 lines (160 loc) · 9.21 KB
Raw

OpenADK (C# version)

Download and installation

To download the OpenADK code, simply click on the 'ZIP' button and uncompress to a directory. Once done, load the appropriate Solution under the src directory in Visual Studio.

The code base should include the latest data models for each locale.

Instructions for generating data model files

Ant must be installed on build computer.

  1. Download both OpenADK .NET and OpenADK Java as sibling projects from GitHub.
  2. From the command line, browse to the open-adk-java/adk-generator folder.
  3. Run 'ant dotnet.deploy'

This will build the .NET SDO libraries and add them to the correct directories in the open-adk-csharp project. Once this is run, open your IDE.

In the case of Visual Studio, the .sln files have already been created so you can open the solution of your choice. They are located in the 'src' directory.

In Visual Studio, use the solution explorer to add the newly generated SDO directory.
Select the project, i.e. OpenADK-UK-SDO. Then at the top of the solution explorer select the 'show all files' button. The generated folders should appear. Right click on the new folders and select 'Include In Project'.

The solution should now be ready to go.

Contributing

For some background information regarding the branching model used by this project, refer to the article A successful Git branching model. The ideas from that article have been combined with the collaborative development techniques recommended by GitHub (specifically Using Pull Requests) to form these procedures.

Pre-requisities

Defined Repositories

The procedures following refer to 3 Git repositories:

  • The remote OpenADK-csharp repository containing a central copy of the code.
  • Your remote repository created within your GitHub account.
  • Your local repository residing on your local machine.

Getting the code

  1. Fork the OpenADK-csharp repository into your remote repository (click on the "Fork" button).

  2. Clone your fork to create your local repository. This will create a OpenADK-csharp directory on your local machine.

    c:\dev> git clone https://github.com/USERNAME/OpenADK-csharp.git

  3. Add the upstream (OpenADK-csharp) repository as a remote. This will allow you to keep track of the OpenADK-csharp repository and pull in updates.

    c:\dev> cd OpenADK-csharp
c:\dev\OpenADK-csharp> git remote add upstream git://github.com/open-adk/OpenADK-csharp.git

  4. Create a topic branch in your remote repository based upon the develop branch and switch to it (your local repository). Do not base your topic branch on any other branch!

    c:\dev\OpenADK-csharp> git checkout -t origin/develop
c:\dev\OpenADK-csharp> git branch ISSUE_XXX develop
c:\dev\OpenADK-csharp> git checkout ISSUE_XXX

Submitting a change

  1. Ensure that all changes applied to the topic branch (locally) have been committed to your remote repository (with an appropriate message). The -a flag skips staging.

    c:\dev\OpenADK-csharp> git commit -a -m MESSAGE

  2. Before submission, ensure that your remote repository is up-to-date.

    c:\dev\OpenADK-csharp> git checkout develop
c:\dev\OpenADK-csharp> git fetch upstream
c:\dev\OpenADK-csharp> git merge upstream/develop

  3. Rebase the changes in your local repository (making for a cleaner history).

    c:\dev\OpenADK-csharp> git checkout ISSUE_XXX
c:\dev\OpenADK-csharp> git rebase develop

  4. Resolve and recommit merge conflicts (if any), and continue the rebase.

    c:\dev\OpenADK-csharp> git rebase --continue

  5. Push your local changes to your remote repository.

    c:\dev\OpenADK-csharp> git push origin ISSUE_XXX

Issue a Pull Request

The Using Pull Requests article provides a comprehensive guide for issuing a Pull Request.

  1. Browse to your remote (forked) repository on the GitHub site.

  2. Switch to the ISSUE_XXX branch and press the "Pull Request" button.

  3. Review the Pull Request details and provide a meaningful title (with issue number if appropriate) and description of your change. It is important to ensure that the base branch is set to develop and the head branch is set to ISSUE_XXX.

  4. Press the "Send pull request" button.

Completion of a Pull Request

Pull Requests are automatically closed when the requested commits are merged into the OpenADK-csharp repository. However, a number of other tasks may be helpful once your changes have been accepted and processed.

  1. Remove the ISSUE_XXX branch both from your local repository and your remote repository.

    c:\dev\OpenADK-csharp> git branch -d *ISSUE_XXX*
c:\dev\OpenADK-csharp> git push origin --delete *ISSUE_XXX*

  2. Update the develop branch of your remote repository with the latest version of the OpenADK-csharp repository.

    c:\dev\OpenADK-csharp> git checkout develop
c:\dev\OpenADK-csharp> git fetch upstream
c:\dev\OpenADK-csharp> git merge upstream/develop
c:\dev\OpenADK-csharp> git push origin develop

Project Maintenance

Merge a Pull Request

GitHub provides the ability for a Pull Request to be automatically merged. If you have the appropriate permissions, the "Merge pull request" button can be used from the "Pull Requests" page. Alternatively, you could perform a manual merge on the command line.

  1. Check out a new branch of the OpenADK-csharp repository to test the changes in.

    c:\dev\OpenADK-csharp> git checkout -b USERNAME-ISSUE_XXX develop

  2. Bring in the changes from the requesting repository into your new branch and perform your tests.

    c:\dev\OpenADK-csharp> git pull https://github.com/USERNAME/OpenADK-csharp.git ISSUE_XXX

  3. Merge the changes and update the OpenADK-csharp repository.

    c:\dev\OpenADK-csharp> git checkout develop
c:\dev\OpenADK-csharp> git merge USERNAME-ISSUE_XXX
c:\dev\OpenADK-csharp> git push origin develop

Creating a released version in master

  1. Merge from release to master.

  2. Tag (annotated) the master branch with an appropriate release number and share it with the OpenADK-csharp repository.

    c:\dev\OpenADK-csharp> git checkout master
c:\dev\OpenADK-csharp> git tag -a X.X.X -m MESSAGE
c:\dev\OpenADK-csharp> git push origin X.X.X

Creating a hotfix

The following steps need to be performed within your remote repository. Care should be taken as these steps operate directory on the master branch.

  1. Create a new topic branch within your remote repository for the hotfix.

    c:\dev\OpenADK-csharp> git checkout -b HOTFIX_XXX master

  2. Apply your changes to the HOTFIX_XXX branch.

  3. Commit your changes.

    c:\dev\OpenADK-csharp> git commit -a -m MESSAGE

  4. Push your local changes to your remote repository.

    c:\dev\OpenADK-csharp> git push origin HOTFIX_XXX

  5. Browse to your remote (forked) repository on the GitHub site.

  6. Switch to the HOTFIX_XXX branch and press the "Pull Request" button.

  7. Review the Pull Request details and provide a meaningful title (with issue number if appropriate) and description of your change. It is important to ensure that the base branch is set to master and the head branch is set to HOTFIX_XXX.

  8. Press the "Send pull request" button.

The following steps need to be performed within the OpenADK-csharp repository.

  1. Browse to the OpenADK-csharp repository on the GitHub site.

  2. Find the Pull Request and merge it (using the "Merge pull request" button).

  3. Before updating the (tag) version number, ensure that locally the code is up-to-date. Tag (annotated) the master branch with an appropriate release number and share it with the OpenADK-csharp repository. With a hotfix submission, increment the third digit of the version number by 1.

    c:\dev\OpenADK-csharp> git checkout master
c:\dev\OpenADK-csharp> git tag -a X.X.X -m MESSAGE
c:\dev\OpenADK-csharp> git push origin X.X.X

  4. Merge the changes into the develop branch.

    c:\dev\OpenADK-csharp> git checkout develop
c:\dev\OpenADK-csharp> git fetch origin
c:\dev\OpenADK-csharp> git merge origin/master
c:\dev\OpenADK-csharp> git push origin develop