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.

Sign up for GitHub

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

Jump to bottom

Update front readme to get actual information of the development #37

Open
3 tasks
BaaltRodrigo opened this issue Oct 23, 2023 · 0 comments
Open
3 tasks

Update front readme to get actual information of the development #37

BaaltRodrigo opened this issue Oct 23, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@BaaltRodrigo
Copy link
Owner

As we moved to version 3.x the old README.md does not make a good representation for this project any more. This needs to be updated first for the devs to follow this project and adds all the the info related to setup the new version of the project.

Documentation for the classes used and information schema stored in the database is not necessary at this moment.

What needs to be done?

  • A way to indicate there is a breaking change that could stop projects to work if updated to v3.x
  • New project setup instructions for developers.
  • Delete old infromation related to v2.x

If more sub-task needs to be added, do it freely
@BaaltRodrigo BaaltRodrigo added the documentation Improvements or additions to documentation label Oct 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@BaaltRodrigo