allure-framework / allure-framework/allure-java

🐞: [Feature] Rename @TmsLink annotation to @Tms

Open
#987 2 comments 0 reactions 0 assignees View on GitHub
triage
Dominant language
Java
Stars
376
Forks
240
Avg merge
1d 7h
Merged PRs (30d)
45

Description

### What happened?

[//]: # (
. Note: for support questions, please use Stackoverflow or Gitter**.
. This repository's issues are reserved for feature requests and bug reports.
.
. In case of any problems with Allure Jenkins plugin** please use the following repository
. to create an issue: https://github.com/jenkinsci/allure-plugin/issues
.
. Make sure you have a clear name for your issue. The name should start with a capital
. letter and no dot is required in the end of the sentence. An example of good issue names:
.
. - The report is broken in IE11
. - Add an ability to disable default plugins
. - Support emoji in test descriptions
)

#### I'm submitting a ...
- [ ] bug report
- [x] feature request
- [ ] support request => Please do not submit support request here, see note at the top of this template.

#### What is the current behavior?
Allure API implementations use different names for TMS links:

JUnit: `@TmsLink`

Cucumber-JVM: `Allure.tms`

NUnit: `[AllureTms]`

Behave: `@allure.tms`

Playwright: `allure.tms`

Jest: `allure.tms`

Cucumber.js and Mocha: `this.tms`

#### What is the expected behavior?
For the sake of coherence, could we rename the `@TmsLink` annotation to `@Tms` for Java JUnit ?

#### What is the motivation / use case for changing the behavior?
To have a coherent API

#### Please tell us about your environment:

- Allure version: 2.25.0
- Test framework: junit 5.10.1
- Allure adaptor: allure-junit5 2.25.0

#### Other information

[//]: # (
. e.g. detailed explanation, stacktraces, related issues, suggestions
. how to fix, links for us to have more context, eg. Stackoverflow, Gitter etc
)

### What Allure Integration are you using?

allure-junit5

### What version of Allure Integration you are using?

2.25.0

### What version of Allure Report you are using?

2.25.0

### Code of Conduct

- [X] I agree to follow this project's Code of Conduct

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.