In case of API changes (DBAL, request_var, etc) it would be a good idea to document these at least to the extent that you know they exist.
It would be great if the develop branch (currently ascraeus) had a file to keep track of these. This could be called something like "docs/api-changes.txt". It would basically act as a bare-bones changelog. Each feature branch can then add a short note to the file, describing what changed.
This "documentation" would not have to be very thorough. It would be very basic but then serve as the foundation of a migration guide later on.
Keeping track of API changes
Forum rules
Please do not post support questions regarding installing, updating, or upgrading phpBB 3.3.x. If you need support for phpBB 3.3.x please visit the 3.3.x Support Forum on phpbb.com.
If you have questions regarding writing extensions please post in Extension Writers Discussion to receive proper guidance from our staff and community.
Please do not post support questions regarding installing, updating, or upgrading phpBB 3.3.x. If you need support for phpBB 3.3.x please visit the 3.3.x Support Forum on phpbb.com.
If you have questions regarding writing extensions please post in Extension Writers Discussion to receive proper guidance from our staff and community.
Re: Keeping track of API changes
I would prefer this to be added to the wiki. And it should be thorough right from the beginning. If we plan to write a migration guide some later time, it'll just not get done, or not be as complete as it should be.
-
bantu
- 3.0 Release Manager
- Posts: 557
- Joined: Thu Sep 07, 2006 11:22 am
- Location: Karlsruhe, Germany
- Contact:
Re: Keeping track of API changes
Agreed.naderman wrote:I would prefer this to be added to the wiki. And it should be thorough right from the beginning. If we plan to write a migration guide some later time, it'll just not get done, or not be as complete as it should be.