Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

64 lines (43 loc) · 1.84 KB

Contributing to DNSimple/C#

Getting Started

1. Clone the repository

Clone the repository and move into it:

git clone [email protected]:dnsimple/dnsimple-csharp.git
cd dnsimple-csharp

2. Install dependencies

3. Build and test

Run the test suite to check everything is working as expected and to install the project specific dependencies (the first time you'll run the script it will install all the dependencies for you).

To run the test suite:

dotnet test

Releasing

The following instructions uses $VERSION as a placeholder, where $VERSION is a MAJOR.MINOR.BUGFIX release such as 1.2.0.

  1. Run the test suite and ensure all the tests pass.

  2. Update PackageReleaseNotes in dnsimple.csproj (located in ./src/dnsimple).

  3. Update PackageVersion in dnsimple.csproj (located in ./src/dnsimple) with the current version.

  4. Finalize the ## main section in CHANGELOG.md assigning the version.

  5. Commit and push the changes

    git commit -a -m "Release $VERSION"
git push origin main

  6. Wait for the CI to complete.

  7. Create a signed tag.

    git tag -a v$VERSION -s -m "Release $VERSION"
git push origin --tags

Testing

Submit unit tests for your changes. You can test your changes on your machine by running the test suite.

When you submit a PR, tests will also be run on the continuous integration environment via GitHub Actions.