Skip to content

Add jvmProfiler to Configuration Options Doc #151

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.

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

Closed
wants to merge 30 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
464a692
docs: create new docs directory
wldeh Jun 5, 2023
a3a303b
docs(README.md): update Kotlin and Gradle prereq versions
wldeh Jun 22, 2023
6652cd8
docs(README.md): update AllOpen plugin usage, backend support, and co…
wldeh Jun 22, 2023
02a2015
docs(configuration-options): add note about build script overriding a…
wldeh Jun 22, 2023
979e0ba
docs(README.md): update README with enhanced explanation and format
wldeh Jun 24, 2023
e74decc
docs(configuration-options): Enhance configuration options table with…
wldeh Jun 24, 2023
d95512b
docs(seperate-source-sets): Refine wording, enhance FAQ section, and …
wldeh Jun 24, 2023
78de037
docs: Add step-by-step setup guide for single-platform project
wldeh Jun 24, 2023
b139400
docs: Add step-by-step setup guide for multi-platform project
wldeh Jun 24, 2023
8da1fdf
docs: Refine benchmarking-overview and benchmark-runtime docs for cla…
wldeh Jun 24, 2023
a1412af
fix: remove placeholder png
wldeh Jun 24, 2023
4c59e60
docs: update broken hyperlinks
wldeh Jun 24, 2023
05d8089
docs(README.md): add hyperlinks and enhance wording
wldeh Jun 27, 2023
c26f523
docs!: overhaul for accuracy and quality
wldeh Jul 1, 2023
143f0db
docs: update structure and wording
wldeh Jul 1, 2023
e00221d
update changelog
wldeh Jul 3, 2023
e5cd512
docs: add READMEs to examples
wldeh Jun 27, 2023
e1d7432
docs: improve descriptions and setup steps
wldeh Jul 6, 2023
b844a64
Add CONTRIBUTING.md and bug report template
wldeh Jul 10, 2023
cad3dfb
correct taks descriptions in readme
wldeh Jul 22, 2023
f9830cc
Improve configuration-options.md (#138)
wldeh Aug 13, 2023
a5eb72a
fixup! Improve configuration-options.md (#138)
Aug 13, 2023
ff74c24
Improve tasks-overview.md (#141)
wldeh Aug 15, 2023
5857760
[WIP] Improve README.md
Jul 8, 2023
24e0555
[WIP] Fix the reference to build status logo
Jul 8, 2023
87ea754
Polish README.md
wldeh Jul 21, 2023
dc32541
Add writing-benchmarks.md
wldeh Jul 21, 2023
5d82b25
Improvements to writing-benchmarks.md doc (#148)
wldeh Sep 1, 2023
a2116f1
add jvmProfiler to config options doc
wldeh Sep 11, 2023
e7f6c40
add hyperlinks to jvmProfiler options in doc
wldeh Sep 12, 2023
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
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Bug report
about: Create a report to help us improve
title: ""
labels: ""
assignees: ""
---

**Describe the bug**

**To Reproduce**
Attach a code snippet or test data if possible.

**Expected behavior**

**Environment**

- Kotlin version: [e.g. 1.3.30]
- Library version: [e.g. 0.11.0]
- Kotlin platforms: [e.g. JVM, JS, Native or their combinations]
- Gradle version: [e.g. 4.10]
- IDE version (if bug is related to the IDE) [e.g. IntellijIDEA 2019.1, Android Studio 3.4]
- Other relevant context [e.g. OS version, JRE version, ... ]
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
# CHANGELOG

## 0.4.8

- Drop legacy JS support
- Support building large JARs [#95](https://github.com/Kotlin/kotlinx-benchmark/issues/95)
- Support Kotlin 1.8.20
- Fix JVM and Native configuration cache warnings

## 0.4.7

- Support Kotlin 1.8.0

## 0.4.6

- Support Gradle 8.0
- Sign kotlinx-benchmark-plugin artifacts with the Signing Plugin
- Upgrade Kotlin version to 1.7.20
- Upgrade Gradle version to 7.4.2

## 0.4.5

- Remove redundant jmh-core dependency from plugin

## 0.4.4

- Require the minimum Kotlin version of 1.7.0
Expand Down
62 changes: 62 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Contributing Guidelines

There are two main ways to contribute to the project — submitting issues and submitting
fixes/changes/improvements via pull requests.

## Submitting issues

Both bug reports and feature requests are welcome.
Submit issues [here](https://github.com/Kotlin/kotlinx-benchmark/issues).

- Search for existing issues to avoid reporting duplicates.
- When submitting a bug report:
- Use a 'bug report' template when creating a new issue.
- Test it against the most recently released version. It might have been already fixed.
- By default, we assume that your problem reproduces in Kotlin/JVM. Please, mention if the problem is
specific to a platform.
- Include the code that reproduces the problem. Provide the complete reproducer code, yet minimize it as much as possible.
- However, don't put off reporting any unusual or rarely appearing issues just because you cannot consistently
reproduce them.
- If the bug is in behavior, then explain what behavior you've expected and what you've got.
- When submitting a feature request:
- Use a 'feature request' template when creating a new issue.
- Explain why you need the feature — what's your use-case, what's your domain.
- Explaining the problem you're facing is more important than suggesting a solution.
Report your problem even if you don't have any proposed solution.
- If there is an alternative way to do what you need, then show the code of the alternative.

## Submitting PRs

We love PRs. Submit PRs [here](https://github.com/Kotlin/kotlinx-benchmark/pulls).
However, please keep in mind that maintainers will have to support the resulting code of the project,
so do familiarize yourself with the following guidelines.

- If you fix documentation:
- If you plan extensive rewrites/additions to the docs, then please [contact the maintainers](#contacting-maintainers)
to coordinate the work in advance.
- If you make any code changes:
- Follow the [Kotlin Coding Conventions](https://kotlinlang.org/docs/reference/coding-conventions.html).
- Use 4 spaces for indentation.
- Use imports with '\*'.
- Build the project to make sure it all works and passes the tests.
- If you fix a bug:
- Write the test that reproduces the bug.
- Fixes without tests are accepted only in exceptional circumstances if it can be shown that writing the
corresponding test is too hard or otherwise impractical.
- Follow the style of writing tests that is used in this project:
name test functions as `testXxx`. Don't use backticks in test names.
- Comment on the existing issue if you want to work on it. Ensure that the issue not only describes a problem,
but also describes a solution that has received positive feedback. Propose a solution if there isn't any.

## Building

This library is built with Gradle.

- Run `./gradlew build` to build. It also runs all the tests.
- Run `./gradlew <module>:check` to test the the module you're currently working on to speed things up during development.

## Contacting maintainers

- If something cannot be done, is not convenient, or does not work, &mdash; submit an [issue](https://github.com/Kotlin/kotlinx-benchmark/issues).
- "How to do something" questions &mdash; [StackOverflow](https://stackoverflow.com).
- Discussions and general inquiries &mdash; use `#benchmarks` channel in [KotlinLang Slack](https://kotl.in/slack).
Loading