diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d690fe547d..c7d0d0da22 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -89,7 +89,7 @@ The whole project is covered by a set of static analysis tools, linters and test Many great ideas for new features come from the community, and we'd be happy to consider yours! -To share your request, you can open an [issue](https://github.com/DataDog/dd-sdk-android/issues/new?labels=enhancement&template=feature_request.md) +To share your request, you can open an [issue](https://github.com/DataDog/dd-sdk-android/issues/new?labels=enhancement&template=FeatureRequest.yml) with the details about what you'd like to see. At a minimum, please provide: - The goal of the new feature; @@ -104,7 +104,7 @@ or UI, contact our support team via https://docs.datadoghq.com/help/ for direct, faster assistance. You may submit bug reports concerning the Datadog SDK for Android by -[opening a Github issue](https://github.com/DataDog/dd-sdk-android/issues/new?labels=bug&template=bug_report.md). +[opening a Github issue](https://github.com/DataDog/dd-sdk-android/issues/new?labels=bug&template=BugReport.yml). At a minimum, please provide: - A description of the problem; @@ -172,14 +172,14 @@ same feature from a Java source code. Our code uses [Detekt](https://detekt.dev/) static analysis with a shared configuration, slightly stricter than the default one. A Detekt check is ran on every on every PR to ensure that all new code follow this rule. -Current Detekt version: 1.22.0 +Current Detekt version: 1.23.4 ### Code style Our coding style is ensured by [KtLint](https://ktlint.github.io/), with the default settings. A KtLint check is ran on every PR to ensure that all new code follow this rule. -Current KtLint version: 0.47.1 +Current KtLint version: 0.50.0 Classes should group their methods in folding regions named after the declaring class. Private methods should be grouped in an `Internal` named folding region. @@ -309,7 +309,7 @@ Here's a test method following those conventions: testedLogger = Logger(mockLogHandler) // When - testedLogger.addAttribute(key, value) + testedLogger.addAttribute(fakeKey, value) testedLogger.v(fakeMessage) // Then @@ -357,5 +357,3 @@ It is recommended to use Closed Box testing as much as possible. To ensure that our tests cover the widest range of possible states and inputs, we use property based testing thanks to the Elmyr library. Given a unit under test, we must make sure that the whole range of possible input is covered for all tests. - -