Audit

Un audit de code a été réalisé sur la version 0.13.3 par David Dérus, disponible en PDF (MD5: 1f6388f976454e37119d6bee268d249a).

Cette page liste tous les points d’améliorations remontés ainsi que leur status.

Avancement : 27/46 27/46

Section	Liens
2.2.1 - Developer documentation is available as a README	Ticket - MR
2.2.3 - There is no documentation explaining the meaning and relationships between data models	Ticket - MR
2.2.4 - There is no instance deployment tutorial or one-click install - Scalingo	Ticket - MR
2.2.4 - There is no instance deployment tutorial or one-click install - Docker	Ticket - MR
2.2.5 - There is a user documentation website, without any actual user documentation	Ticket
2.2.6 - The README is too long and contains instructions for both developers and people wanting to deploy the project	Ticket - MR
2.2.7 - The API documentation is auto-generated, but not published online	Ticket - MR
2.2.8 - Online documentation is not up to date with the latest build
2.3.4 - Garden Party Ruby version is not maintained anymore	Ticket - MR
2.3.5 - The application Node version is obsolete	Ticket - MR
2.3.6 - The users search endpoint is accessible without authentication	Ticket - MR
2.3.7 - The application data sources could be GPG signed	Ticket
2.4.3 - Using bitfields is adding complexity between the code and database layer	Ticket
2.4.4 - Content migration classes should be extracted from database migrations for easier testing	Ticket
2.4.5 - Using an abstract model class to handle `GeometryRecord` is not the “Rails way”	Ticket - MR
2.5.9 - Routing specs are duplicates of requests specs and testing Rails inner working	Ticket - MR
2.5.10 - Some domain logic code is duplicated	Ticket
2.5.11 - Avoid nesting tests to three levels or deeper	Ticket - MR
2.5.12 - Front-end and back-end code are tightly coupled	Ticket
2.5.13 - The full Ruby and JavaScript test suites are taking some time to run	Ticket
2.5.14 - Front-end API requests are using the XMLHttpRequest method	Ticket - MR
2.5.15 - The JavaScript application is mixing rise-ui and storybook	Ticket - MR
2.5.16 - Policies tests can be DRYed	Ticket
2.5.17 - The `database_cleaner` gem may not be required	Ticket - MR
2.5.18 - The HAML rendering gem should be replaced by hamlit for better performances	Ticket - MR
2.5.19 - Extract domain logic from controllers, models and validators	Ticket
2.5.20 - The application is requiring the whole Ruby on Rails stack, even if it is not using parts of it.	Ticket
2.5.21 - Rails admin views could be componentised to avoid code repetition and improve maintainability	Ticket - MR
2.5.22 - The VueX store is accessed directly from the front-end components	Ticket
2.5.23 - The GardenMap state is updated through an event bus	Ticket
2.5.24 - Picture analysis could be delayed through ActiveJob	Ticket
2.6.3 - The application contrast ratio must be increased	Ticket - MR
2.6.4 - Irreversible action alerts are not helpful	Ticket - MR
2.6.5 - There is no way to go back to top on the observations timeline	Ticket
2.6.6 - The onboarding process is lacking some visible and understandable instructions	Ticket
2.6.7 - Avoid covering the whole website with a loader	Ticket - MR
2.6.8 - Use CSS cursors to help understand available actions	Ticket - MR
2.6.9 - Context menu navigation is using two icons to say the same thing	Ticket - MR
2.6.10 - In guest mode, the “observations” tab is duplicated, while referring to a different feature	Ticket
2.6.11 - Deleting a path hides all its resources	Ticket - MR
2.6.12 - Some buttons are hiding the tab bar	Ticket
2.6.13 - The map layout should show plants information on hover	Ticket - MR
2.6.14 - Map scale can be 200 km and can’t be limited	Ticket
2.6.15 - Avoid showing the lightbox arrows if there is no previous or next	Ticket - MR
2.6.16 - The map zoom capacities should be improved	Ticket - MR
2.6.17 - Hide withdrawn items from the main inventory	Ticket - MR