Democratizing Development: Difference between revisions
Jump to navigation
Jump to search
(Add G's review) |
|||
| Line 20: | Line 20: | ||
3. Automation | 3. Automation | ||
The [https://github.com/gbroques/ose-workbench-platform OSE Workbench Platform] exemplifies many of these industry standard best-practices. | The [https://github.com/gbroques/ose-workbench-platform OSE Workbench Platform] exemplifies many of these industry standard best-practices in the above key-areas. | ||
For example: | For example: | ||
| Line 28: | Line 28: | ||
** '''Seamless build systems''' - OSE Workbench Platform leverages [https://www.docker.com/ Docker] and containerization technology to create reproducible builds and distributed local development environments for workbench development | ** '''Seamless build systems''' - OSE Workbench Platform leverages [https://www.docker.com/ Docker] and containerization technology to create reproducible builds and distributed local development environments for workbench development | ||
** '''Write thoughtful error messages''' - OSE Workbench Platform includes a <code>osewb</code> '''CLI''' with thoughtful error messages that tell users what went wrong, and commands to execute in order to fix the problem. The OSE Workbench Core library also prints great warning messages in '''FreeCAD's Report view''' when unexpected scenarios occur for troubleshooting and debugging. | ** '''Write thoughtful error messages''' - OSE Workbench Platform includes a <code>osewb</code> '''CLI''' with thoughtful error messages that tell users what went wrong, and commands to execute in order to fix the problem. The OSE Workbench Core library also prints great warning messages in '''FreeCAD's Report view''' when unexpected scenarios occur for troubleshooting and debugging. | ||
** OSE Workbench Platform generates new workbenches with support for | ** OSE Workbench Platform generates new workbenches with out-of-the-box support for modern-looking and mobile-friendly documentation sites, in addition to [https://ose-workbench-platform.readthedocs.io/en/latest/index.html it's own documention site] | ||
* '''Test''' | * '''Test''' | ||
** OSE Workbench Platform generates new workbenches with out-of-the-box support for unit tests and continuous integration via Travis CI. | ** OSE Workbench Platform generates new workbenches with out-of-the-box support for unit tests and continuous integration via Travis CI. | ||
| Line 34: | Line 34: | ||
* '''Automation''' | * '''Automation''' | ||
** OSE Workbench Platform provides the <code>osewb</code> CLI to automate common and repetitive tasks OSE workbench developers perform | ** OSE Workbench Platform provides the <code>osewb</code> CLI to automate common and repetitive tasks OSE workbench developers perform | ||
** OSE Workbench Platform provides an <code>osewb init</code> command to | ** OSE Workbench Platform provides an <code>osewb init</code> command to generate new workbenches automatically | ||
** OSE Workbench Platform plans to provide a <code>osewb make</code> command to initialize code for common patterns | ** OSE Workbench Platform plans to provide a <code>osewb make</code> command to initialize code for common patterns | ||
*** This will be similar to [https://quickadminpanel.com/blog/list-of-21-artisan-make-commands-with-parameters/ Laravel's, the leading PHP Web Development framework, php artisan make command]. | *** This will be similar to [https://quickadminpanel.com/blog/list-of-21-artisan-make-commands-with-parameters/ Laravel's, the leading PHP Web Development framework, php artisan make command]. | ||
=Links= | =Links= | ||
*Testing - https://www.bunniestudios.com/blog/?p=5450 | *Testing - https://www.bunniestudios.com/blog/?p=5450 | ||
Revision as of 19:11, 31 May 2020
What are some best practices that make access to contributing easy?
OSHWA Summit 2020
https://www.youtube.com/watch?v=M9AU4CoI2c8&list=PLN2I5IwhHQ4pmaknussTtkO30SNJdlG4o&index=7
G's Review
User:Groques's review:
Offers a good introduction of how the maturation of free and open-source software development led to increased democratization of the field.
Mentions a few key areas of best-practices in software development for open-source hardware to follow to become equally democratized:
1. Accessibility
2. Test
3. Automation
The OSE Workbench Platform exemplifies many of these industry standard best-practices in the above key-areas.
For example:
- Accessibility
- Provide great libraries - OSE Workbench Platform will include the OSE Workbench Core library with common functionality to all workbenches
- Seamless build systems - OSE Workbench Platform leverages Docker and containerization technology to create reproducible builds and distributed local development environments for workbench development
- Write thoughtful error messages - OSE Workbench Platform includes a
osewbCLI with thoughtful error messages that tell users what went wrong, and commands to execute in order to fix the problem. The OSE Workbench Core library also prints great warning messages in FreeCAD's Report view when unexpected scenarios occur for troubleshooting and debugging. - OSE Workbench Platform generates new workbenches with out-of-the-box support for modern-looking and mobile-friendly documentation sites, in addition to it's own documention site
- Test
- OSE Workbench Platform generates new workbenches with out-of-the-box support for unit tests and continuous integration via Travis CI.
- OSE Workbench Platform also provides support for generating coverage reports to aid in finding holes and gaps in current test coverage
- Automation
- OSE Workbench Platform provides the
osewbCLI to automate common and repetitive tasks OSE workbench developers perform - OSE Workbench Platform provides an
osewb initcommand to generate new workbenches automatically - OSE Workbench Platform plans to provide a
osewb makecommand to initialize code for common patterns- This will be similar to Laravel's, the leading PHP Web Development framework, php artisan make command.
- OSE Workbench Platform provides the