Skip to content

Latest commit

 

History

History
96 lines (62 loc) · 3.61 KB

CONTRIBUTING.md

File metadata and controls

96 lines (62 loc) · 3.61 KB
Raw

Development and Testing

To run the project locally, clone the repository.

git clone https://github.com/amadeus4dev/amadeus-dotnet.git
cd amadeus-java

Download and install visual studio.

Install workloads dependencies.

.NET desktop development
Universal Windows Platform development

Open project/solution

Right click in the solution and select Manage Nuget Packages and install other dependencies.

xunit -- (Project: amadeus-integration-test) -- version: last
xunit.runner.visualstudio -- (Project: amadeus-integration-test) -- version: last
coverlet.collector -- (Project: amadeus-integration-test) -- version: last
Microsoft.AspNetCore.App -- (Project: amadeus-test) -- version: 2.1.0
Microsoft.AspNetCore.TestHost -- (Project: amadeus-integration-test) -- version: 2.1.0
Microsoft.NET.Test.Sdk -- (Project: amadeus-integration-test) -- version: last
System.Runtime.CompilerServices.Unsafe -- (Project: amadeus-test) -- version: last
System.Threading.Tasks.Extensions -- (Project: amadeus-test) -- version: last
NunitTestAdapter -- (Project: amadeus-test) -- version: 2.1.0
Nunit -- (Project: amadeus-test) -- version: last
Castle.Core -- (Project: amadeus-test) -- version: last
Moq -- (Project: amadeus-test) -- version: last

Running tests

Open Test Explorer.

Click Run All Tests option.

Building

Open Solution Explorer right click on the project Amadeus and select build.

Releasing

To make a new release, follow the following steps:

  • Update the CHANGELOG.md with the new version
  • Tag your release in git using git --tag vX.X.X
  • Push the new tag git push --tags
  • Update the Releases tab on GitHub with a new release for the tag, copying the description from the CHANGELOG.md

Create the package to publish.

  • Right click in amadeus project and select properties.
  • Select Package tab.
  • Change package version; release notes; assembly version.
  • Right click in amadeus project and select pack.

Publish package in nuget.org.

  • Login in https://www.nuget.org/
  • Select upload option and browse the amadeus-dotnet..nupkg file.
  • Choose the owner amadeus4dev and save.

How to contribute to the Amadeus Dotnet SDK

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Do you intend to add a new feature or change an existing one?

  • Suggest your change in a new issue and start writing code.

  • Make sure your new code does not break any tests and include new tests.

  • With good code comes good documentation. Try to copy the existing documentation and adapt it to your needs.

  • Close the issue or mark it as inactive if you decide to discontinue working on the code.

Do you have questions about the source code?