Skip to content

[doc] ADR 3 - API evolution principles#4756

Merged
adangel merged 5 commits into
pmd:masterfrom
adangel:issue-995-api-doc
Jan 12, 2024
Merged

[doc] ADR 3 - API evolution principles#4756
adangel merged 5 commits into
pmd:masterfrom
adangel:issue-995-api-doc

Conversation

@adangel

@adangel adangel commented Dec 1, 2023

Copy link
Copy Markdown
Member

Describe the PR

First proposal - comments are welcome!

Note - this is kind of a vision/mixture. Some API refactoring tasks are not done yet (see #3898) - so, the proposal does not necessary reflect the current code base.

I've also not included @DeprecatedUntil700 since I expect this to be gone for the final 7.0.0 release.

Related issues

Ready?

  • Added unit tests for fixed bug/feature
  • Passing all unit tests
  • Complete build ./mvnw clean verify passes (checked automatically by github actions)
  • Added (in-code) documentation (if needed)

@adangel adangel added the in:documentation Affects the documentation [doc] label Dec 1, 2023
@adangel adangel added this to the 7.0.0 milestone Dec 1, 2023
@ghost

ghost commented Dec 1, 2023

Copy link
Copy Markdown
1 Message
📖 Compared to master:
This changeset changes 0 violations,
introduces 0 new violations, 0 new errors and 0 new configuration errors,
removes 0 violations, 0 errors and 0 configuration errors.
Download full report as build artifact
Compared to master:
This changeset changes 0 violations,
introduces 0 new violations, 0 new errors and 0 new configuration errors,
removes 0 violations, 0 errors and 0 configuration errors.
Download full report as build artifact

Generated by 🚫 Danger

@adangel adangel mentioned this pull request Dec 1, 2023
55 tasks

@oowekyala oowekyala left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you for writing this up

Comment thread docs/pages/pmd/projectdocs/decisions/adr-3.md
Comment thread docs/pages/pmd/projectdocs/decisions/adr-3.md Outdated
Comment thread docs/pages/pmd/projectdocs/decisions/adr-3.md Outdated
* clarify impl
* remove @ReservedSubclassing
adangel added a commit that referenced this pull request Jan 12, 2024
[doc] ADR 3 - API evolution principles #4756
@adangel adangel merged commit 4666d22 into pmd:master Jan 12, 2024
@adangel adangel deleted the issue-995-api-doc branch January 12, 2024 08:52
adangel added a commit to adangel/pmd that referenced this pull request Feb 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

in:documentation Affects the documentation [doc]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[doc] Document API evolution principles as ADR

2 participants