search

plone / volto

React-based frontend for the Plone Content Management System
https://demo.plone.org/
MIT License
426 stars 575 forks source link

#5341 code analysis documentation #5882

Closed ichim-david closed 1 month ago

ichim-david commented 1 month ago

Fixes #5341 code analysis after some much-needed magic from @stevepiercy :)

netlify[bot] commented 1 month ago

Deploy Preview for plone-components canceled.

Name Link
Latest commit 487dcce7e72d8883f9a72e79accca4c715720173
Latest deploy log https://app.netlify.com/sites/plone-components/deploys/65f733db10fa3100082f8c32
netlify[bot] commented 1 month ago

Deploy Preview for volto ready!

Name Link
Latest commit 487dcce7e72d8883f9a72e79accca4c715720173
Latest deploy log https://app.netlify.com/sites/volto/deploys/65f733dbcdb270000811f16e
Deploy Preview https://deploy-preview-5882--volto.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

ichim-david commented 1 month ago

@stevepiercy before passing to tech review I'm sure you will find a bunch of wording changes so after you make all of the suggestions and you give the go-ahead I will add other core devs to have a look.

ichim-david commented 1 month ago

I pushed a commit for cleaning up acceptance-tests.md.

I have to admit, this is the first time I have ever run Cypress locally, and I'm amazed. It might actually encouraged me to contribute to Volto core, beside its documentation. @ichim-david is my hero.

I cannot emphasize enough the importance that this contribution has to future contributions to Volto.

I still need to review the other files, but I have to say so far, this single contribution may do more than any other contribution in recent history to encourage more contributions.

"If it ain't documented, it's broken" reigns true.

@stevepiercy this reply is awesome, thank you for the appreciation, I appreciate it deeply :).

I will be one of your tag team partners, I will write something that will get us to the 80% done and you will get it to that final 20% to reach the final line. It's hard to write and write good but knowing that I have someone like you that can iron things out makes it easier for me to want to contribute and help. Ideally we should try todo the same with code contributions and step in if other contributors need help and they ask for our help as it will ensure more contributions and with higher quality made quicker rather than waiting for one guy todo it all.

stevepiercy commented 1 month ago

@ichim-david I think we don't need to wait for my English grammar and documentation structure organization. Let's get everyone who should be involved in reviews participating now, as everyone has different schedules and availability. It will be an iterative process, but it will be much better than what we have now.

For the acceptance tests, are there any other use cases that should be included? To be honest, I'm overwhelmed with how we can use Cypress, and I have no idea how to best use it.

stevepiercy commented 1 month ago

I've completed my review. @sneridagh @ichim-david please take another look at the whole thing, and check the preview build, too.

ichim-david commented 1 month ago

@sneridagh @stevepiercy It would be too weird to accept my own pull request :) but it feels like something so much better after all of the extra formatting and references done by Steve. I've checked it and from my point of view it's a merge, I'm waiting to see if Victor has anything else that wants to be changed otherwise we could merge anytime we feel like it.