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

Write documentation on the options and limitations of renaming/removing adapter codes #5565

Open
muuki88 opened this issue Aug 22, 2024 · 2 comments

Comments

@muuki88
Copy link
Contributor

muuki88 commented Aug 22, 2024

Renaming or removing adapters is always painful and there's not enough guidance on what can and should be done.

@muuki88 muuki88 changed the title Write documentation on the options and limitations of renaming adapter codes Write documentation on the options and limitations of renaming/removing adapter codes Aug 22, 2024
@bretg
Copy link
Contributor

bretg commented Aug 22, 2024

We already have this FAQ entry https://docs.prebid.org/dev-docs/faq.html#im-a-developer---how-do-i-change-the-name-of-my-module

Sounds like we need to expand this a bit:

  • cover the case of removing an alias
  • help reviewers in PBJS, PBS, and docs teams understand and enforce

@muuki88
Copy link
Contributor Author

muuki88 commented Aug 22, 2024

Yeah, there are multiple cases missing

  • removing an aliases
  • changing an aliases
  • remove a module
  • rename a module (covered)
  • mark module not available for versions (due to removal in major version an non-compliance)

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

No branches or pull requests

2 participants