Skip to content

Commit

Permalink
review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
tanderson-ld committed Jun 10, 2024
1 parent 780e8a5 commit be62b6f
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 4 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Contributing to the LaunchDarkly .NET Core repository

LaunchDarkly has published an [SDK contributor's guide](https://docs.launchdarkly.com/sdk/concepts/contributors-guide) that provides a detailed explanation of how our SDKs work. See below for additional information on how to contribute to this SDK.

## Submitting bug reports and feature requests

The LaunchDarkly SDK team monitors the [issue tracker](https://github.com/launchdarkly/dotnet-core/issues) in the SDK repository. Bug reports and feature requests specific to this SDK should be filed in this issue tracker. The SDK team will respond to all newly filed issues within two business days.

## Submitting pull requests

We encourage pull requests and other contributions from the community. Before submitting pull requests, ensure that all temporary or unintended code is removed. Don't worry about adding reviewers to the pull request; the LaunchDarkly SDK team will add themselves. The SDK team will acknowledge all pull requests within two business days.

## Build instructions

Build instructions for a package can be found in the package's source directory.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# LaunchDarkly monorepo for .NET SDKs and C# libs.

This repository contains LaunchDarkly SDK packages for usage in .NET.
This includes shared libraries, used by SDKs and other tools, as well as SDKs.
This includes the SDKs, shared libraries, and other tools.

## Packages

Expand Down Expand Up @@ -38,7 +38,7 @@ We run integration tests for all our SDKs using a centralized test harness. This

## Contributing

We encourage pull requests and other contributions from the community. Check out our [contributing guidelines](CONTRIBUTING.md) for instructions on how to contribute to this SDK.
We encourage pull requests and other contributions from the community. Check out our [contributing guidelines](CONTRIBUTING.md) for instructions on how to contribute to this repository.

## About LaunchDarkly

Expand Down
2 changes: 1 addition & 1 deletion pkgs/sdk/client/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,6 @@ make contract-tests

The equivalent test suites for MAUI (Android or iOS) must be run in an Android or iOS emulator. The project `test/LaunchDarkly.ClientSdk.Device.Tests` consist of a test applications based on the `xunit.runner.devices` tool, which show the test results visually in the emulator and also write the results to the emulator's system log. The actual unit test code is just the same tests from the main `tests/LaunchDarkly.ClientSdk.Tests` project, but running them in this way exercises the mobile-specific behavior for those platforms (e.g. caching flags in user preferences).

You can run the mobile test projects from Visual Studio (the iOS tests require MacOS); there is also a somewhat complicated process for running them from the command line, which is what the CI build does (see `.circleci/config.yml`).
You can run the mobile test projects from Visual Studio (the iOS tests require MacOS).

Note that the mobile unit tests currently do not cover background-mode behavior or connectivity detection.
2 changes: 1 addition & 1 deletion pkgs/sdk/server/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,4 @@ make contract-tests

All public types, methods, and properties should have documentation comments in the standard C# XML comment format. These will be automatically included in the documentation that is generated on release; this process also uses additional Markdown content from the respective packages `docs-src/` subdirectory.

See `docs-src/README.md` for more details.
See [`docs-src/README.md`](./docs-src/README.md) for more details.

0 comments on commit be62b6f

Please sign in to comment.