Difference between revisions of "Project:Outreachy 2020 Perl code quality"

From Open Food Facts wiki
Jump to navigation Jump to search
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
 
Outreachy provides internships to work in open source and free software. The time duration of the internship is 3 months (18th May'20 - 19th August'20).
 
Outreachy provides internships to work in open source and free software. The time duration of the internship is 3 months (18th May'20 - 19th August'20).
 +
The project is 'Improve the code quality of the Perl backend of Open Food Facts'. Over the last 8 years, the Open Food Facts code base has grown a lot organically, which makes contributing not very welcoming for developers, and sometimes also causes performance issues and bugs.
 +
This project is to improve the architecture, performance, code quality, tests and documentation of Open Food Facts.
  
 
== Overview ==
 
== Overview ==
Line 10: Line 12:
 
* Extension in the coverage of unit tests
 
* Extension in the coverage of unit tests
 
* POD Documentation
 
* POD Documentation
* Re-architecture of the modules and functions
+
* Re-architecturing of the modules and functions
* Make OFF easier to build
+
* Making the installation of dev environment for Open Food Facts easier
  
 
== Resources ==
 
== Resources ==
  
(links to notes, blogs, github branches etc.)
+
Here's a link to the intern Areesha Tariq internship blog:
 
+
https://medium.com/@areeshatariq02
 
[[Category:Project:Outreachy_2020_Perl_code_quality]]
 
[[Category:Project:Outreachy_2020_Perl_code_quality]]

Latest revision as of 20:55, 30 May 2020

Summary

Outreachy provides internships to work in open source and free software. The time duration of the internship is 3 months (18th May'20 - 19th August'20). The project is 'Improve the code quality of the Perl backend of Open Food Facts'. Over the last 8 years, the Open Food Facts code base has grown a lot organically, which makes contributing not very welcoming for developers, and sometimes also causes performance issues and bugs. This project is to improve the architecture, performance, code quality, tests and documentation of Open Food Facts.

Overview

The project includes several sub-projects:

  • Templating of the HTML code
  • Extension in the coverage of unit tests
  • POD Documentation
  • Re-architecturing of the modules and functions
  • Making the installation of dev environment for Open Food Facts easier

Resources

Here's a link to the intern Areesha Tariq internship blog: https://medium.com/@areeshatariq02