-
Improvement
-
Resolution: Fixed
-
Minor
-
None
-
-
43.vea_da_7c53b_831
Hello,
I'd like to enhance the docs of this plugin and create a PR for that.
However, I've realized that there is a naming inconsistency between GitHub and Bitbucket which is super confusing.
- In GitHub, the trait is called 'notificationsSkip'.
https://github.com/jenkinsci/skip-notifications-trait-plugin/blob/ffaa9a99b850ec84a20372150acd735a80016bb2/src/main/java/org/jenkinsci/plugins/github/notifications/NotificationsSkipTrait.java#L66 - In Bitbucket, the trait is called 'skipNotifications'.
https://github.com/jenkinsci/skip-notifications-trait-plugin/blob/ffaa9a99b850ec84a20372150acd735a80016bb2/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/notifications/SkipNotificationsTrait.java#L59
Not sure if that intended or there are any constraints that force that naming inconsistency.
Thanks
[JENKINS-64360] Naming inconsistency between GitHub and Bitbucket
Component/s | New: skip-notifications-trait-plugin [ 23947 ] | |
Component/s | Original: atlassian-bitbucket-server-integration-plugin [ 25721 ] |
Issue Type | Original: Bug [ 1 ] | New: Improvement [ 4 ] |
Assignee | Original: Kristy Hughes [ khughes ] | New: Valentin Delaye [ jonesbusy ] |
Status | Original: Open [ 1 ] | New: In Progress [ 3 ] |
Status | Original: In Progress [ 3 ] | New: Open [ 1 ] |
Resolution | New: Fixed [ 1 ] | |
Status | Original: Open [ 1 ] | New: Fixed but Unreleased [ 10203 ] |
I think the naming has to be different to avoid clashes (see, e.g. https://issues.jenkins.io/browse/JENKINS-61464). That said, it feels like clearer naming might be:
skipBitbucketNotifications
skipGitHubNotifications
skipGitLabNotifications
etc. It's more verbose, but seems more consistent and extensible than the current approach.