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

Roadmap #98

Open
3 of 4 tasks
sergei-maertens opened this issue Jun 11, 2023 · 5 comments
Open
3 of 4 tasks

Roadmap #98

sergei-maertens opened this issue Jun 11, 2023 · 5 comments
Milestone

Comments

@sergei-maertens
Copy link
Collaborator

sergei-maertens commented Jun 11, 2023

Link to project board: https://github.com/orgs/jazzband/projects/13/views/1


Now that 0.4.0 is released to PyPI and the most pressing matters are resolved, we can look ahead to the future and get a stable version published.

There is a milestone for the 1.0 release and any issues that must be resolved before that release are attached to it.

Note that jumping from the 0.x.y versioning scheme to 1.0.z allows for introducing breaking changes. The breaking changes towards 1.0 will likely require updating your code, but we should aim to do these as soon as possible if they are needed to get them out of the way.

Breaking changes after that will require a bump to 2.0, 3.0 etc.. Dropping support for no-longer maintained Django versions technically qualifies as a breaking change, so we will handle them as such. Those changes typically won't require you updating your code. If, however, we do introduce future breaking changes, they will be clearly communicated.

Now, for the roadmap - these are roughly the goals/reworks that must be completed before we can publish 1.0

  • Solving the Javascript integration properly (Unable To Minify / Compress Changing JavaScript Into 1 File #15, Not compatible with page cache #49). In short, there should probably be a move towards a JSON view for async fetching of the cookie groups/configuration and rewrite the cookiebar JS (and supporting JS) to handle this. Inline JS is annoying in general in combination with Content-Security-Policy too, so in general this should be a good move. Please try 0.5.0b0 and report back your experiences!
  • Scripting cleanup and tooling: ideally, people should be able to drop the shipped scripts/modules in Webpack or their bundler/toolchain of choice. I'd also like to explore <script type="module" ... /> to support modern browsers. This may not drop support for simple staticfiles integration and will still be available. We may set up a bit more of a toolchain for JS (and possibly look into Typescript so we can also ship types for users on a typescript toolchain). Modules are now available in 0.5.0b0, but integrating in your frontend toolchain depends on ideas/feedback from the community.
  • Fixture support (for moving between staging/prod environment) via natural primary key Integrate with Django's dumpdata command via natural primary/foreign key #103
  • Good defaults but extensible architecture - see Allow storing additional metadata #34
@sergei-maertens sergei-maertens added this to the Release 1.0 milestone Jun 11, 2023
@sergei-maertens sergei-maertens pinned this issue Jun 11, 2023
@fabienheureux
Copy link

@sergei-maertens are there people actively working on this project ?

@sergei-maertens
Copy link
Collaborator Author

@sergei-maertens are there people actively working on this project ?

I definitely am! Of course I'm distributing my time over a couple of projects, so my development work is typically in bursts

@fabienheureux
Copy link

That is great to hear, I am using it on production on a project.
Are there any area of the roadmap that you need help with ?

@sergei-maertens
Copy link
Collaborator Author

sergei-maertens commented Sep 21, 2023 via email

@sergei-maertens
Copy link
Collaborator Author

@fabienheureux I've been ticking off some items and that resulted in a couple more issues on the backlog with concrete tasks.

Either way, the good first issue filter has some easy-pickings, and the milestone issues also have some less-straightforward things if you're comfortable with that.

I will assign the issues to myself that are being covered with the JS rework so it's clear they're being worked on :) Feel free to pick up anything else if you'd like!

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