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

Very high level project plan #1049

Open
fulldecent opened this issue Jul 12, 2024 · 0 comments
Open

Very high level project plan #1049

fulldecent opened this issue Jul 12, 2024 · 0 comments

Comments

@fulldecent
Copy link
Sponsor

Hello, I am learning about phplist, it looks good and well-maintained. I am planning on installing it and trying to make the most of it. That includes contributing in whatever ways, and making this software part of our business.

I'm hoping there can please be at least a very high level project plan in the README about the plans for this project. This will help align the community and it also sort of explains what type of code contributions are sought.

Here is a rough draft based on my current understanding and guesses:


High-level project plan [DRAFT]

For the next version of our software, we plan to use the same database schema as currently used in the latest release of phpList 3. But we will use a new REST API for the next release, and we will publish this contract with an OpenAPI/Swagger specification. [Our front end will then depend on that REST API | Our front end will work independent from that REST API].

Major work parts:

  1. Require a supported version of PHP, 8.1 or later.
  2. Develop the related phpList 4 and REST API projects to add all API routes required for the next version of phpList.
  3. Move phpList 4 and the REST API code into this repository (phplist3) as a dependency, delete those other repositories. Resolve all security issues and incompatibilities between API versions 3 and 4.
  4. Deprecate REST API routes that will not be supported in the next version. Release as a patch version bump.
  5. Rename this repository to just phplist, dropping the 3 at the end.
  6. Release phpList 4.0.0.
  7. Rewrite the HTML generating code for administrators and list members, preferring to use [PHP spagetti code | static HTML/JS | some other front end] and release as a minor version bump.

Or if the actual project plans are different than what I understand above, then hopefully that level of detail could please be added to the README to inform and focus efforts.

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

1 participant