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.

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

PLUGINAPI-110 Remove deprecation on Hotspots statuses and resolutions… #203

Conversation

dejan-milisavljevic-sonarsource
Copy link
Contributor

@dejan-milisavljevic-sonarsource dejan-milisavljevic-sonarsource commented Dec 5, 2024

PLUGINAPI-110

… values

For SonarSourcers:

  • Create a JIRA ticket if the API is impacted
  • Prefix the commit message with the ticket number
  • Document the change in CHANGELOG.md
  • When adding a new API:
    • Explain in the JavaDoc the purpose of the new API
    • Add a @since X.Y in the JavaDoc
  • When deprecating an API:
    • Annotate the deprecated element with @Deprecated
    • Add a @deprecated since X.Y in the JavaDoc
    • Document the replacement in the JavaDoc (if any)
  • When dropping an API:
  • Make sure the tests adhere to the convention:
    • All test method names should use snake_case, for example: test_validate_input. It can also start with the methodName
  • Make sure checks are green: build passes, Quality Gate is green
  • Merge after getting approval by at least one member of the guild
    • If no review is made within 3 days, gently ping the reviewers
    • The guild member reviewing the code can explicitly request someone else (typically another guild member representing another team) to check the impact on the specific product
    • In some cases, the guild may deem it necessary that multiple or even all members approve a PR. This is more likely in complex changes or changes directly impacting all teams using the API.

For external contributors:

Please be aware that we are not actively looking for feature contributions. The truth is that it's extremely difficult for someone outside SonarSource to comply with our roadmap and expectations. Therefore, we typically only accept minor cosmetic changes and typo fixes. If you would like to see a new feature, please create a new thread in the forum "Suggest new features".

With that in mind, if you would like to submit a code contribution, make sure that you adhere to the following guidelines and all tests are passing:

Please explain your motives to contribute this change: what problem you are trying to fix, what improvement you are trying to make
Use the following formatting style: SonarSource/sonar-developer-toolset
Provide a unit test for any code you changed
If there is a JIRA ticket available, please make your commits and pull request start with the ticket ID (PLUGINAPI-XXXX)
We will try to give you feedback on your contribution as quickly as possible.

Thank You! The SonarSource Team

Copy link

sonarqube-next bot commented Dec 5, 2024

@dejan-milisavljevic-sonarsource dejan-milisavljevic-sonarsource marked this pull request as draft December 5, 2024 10:33
@dejan-milisavljevic-sonarsource dejan-milisavljevic-sonarsource force-pushed the feature/dejan/PLUGINAPI-110-undeprecate-security-hotspot branch from 57bb0b1 to 4724ec1 Compare December 23, 2024 07:44
@dejan-milisavljevic-sonarsource dejan-milisavljevic-sonarsource marked this pull request as ready for review December 23, 2024 07:46
Copy link

Copy link
Contributor

@pierre-guillot-gh pierre-guillot-gh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code change is looking good. I think it would be useful to describe in a few words why we are removing this deprecation in the Jira ticket. (Or at least link it to the MMF re-introducing the support, so we can connect the reasoning behind the change)

@dejan-milisavljevic-sonarsource dejan-milisavljevic-sonarsource merged commit 8921712 into master Jan 2, 2025
8 checks passed
@dejan-milisavljevic-sonarsource dejan-milisavljevic-sonarsource deleted the feature/dejan/PLUGINAPI-110-undeprecate-security-hotspot branch January 2, 2025 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants