Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CONTRIBUTING doc changes #2275

Merged
merged 2 commits into from
Sep 23, 2024
Merged

CONTRIBUTING doc changes #2275

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
61d781f
Update issue templates links in CONTRIBUTING.md
0xnm Sep 23, 2024
0f35539
Update Detekt and Ktlint versions in CONTRIBUTING.md
0xnm Sep 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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;
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.