Difference between revisions of "Outreachy 2022"

From Open Food Facts wiki
Jump to navigation Jump to search
(fix mess (wikimedia ate part of my previous content…) !)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
===Summary===
 
===Summary===
 +
 
[https://www.outreachy.org Outreachy] program provides us two intern for 2022, thanks to the [https://www.perlfoundation.org/ Perlfoundation]
 
[https://www.outreachy.org Outreachy] program provides us two intern for 2022, thanks to the [https://www.perlfoundation.org/ Perlfoundation]
  
Line 5: Line 6:
  
 
===Description===
 
===Description===
'''Status''': {{{status}}}
 
  
'''People''': {{{who}}}
+
'''Status''': planning
 +
 
 +
'''People''': Raquel DiPietro, Yukti Sharma and mentors: [[User:Alex-off|Alex-off]] and [[User:Stephane|Stephane]]
 +
 
 
====Impact (why)====
 
====Impact (why)====
 +
 
Improving Perl code quality and documentation is a great way to help the project move forward at a faster pace in the future.
 
Improving Perl code quality and documentation is a great way to help the project move forward at a faster pace in the future.
  
Line 18: Line 22:
 
Improve code quality by:
 
Improve code quality by:
  
* {{{expected_outcomes_what}}}- adding unit tests to functions that lack them
+
* adding unit tests to functions that lack them
- adding integration tests
+
* adding integration tests
- investigating the cause of warnings (e.g. unitialized variables) and fixing them
+
* investigating the cause of warnings (e.g. unitialized variables) and fixing them
- possibly refactoring some parts of the code to make it more simple and readable
+
* possibly refactoring some parts of the code to make it more simple and readable
* {{{expected_outcomes_what}}}- adding unit tests to functions that lack them
 
- adding integration tests
 
- investigating the cause of warnings (e.g. unitialized variables) and fixing them
 
- possibly refactoring some parts of the code to make it more simple and readable
 
* {{{expected_outcomes_what}}}- adding unit tests to functions that lack them
 
- adding integration tests
 
- investigating the cause of warnings (e.g. unitialized variables) and fixing them
 
- possibly refactoring some parts of the code to make it more simple and readable
 
* {{{expected_outcomes_what}}}- adding unit tests to functions that lack them
 
- adding integration tests
 
- investigating the cause of warnings (e.g. unitialized variables) and fixing them
 
- possibly refactoring some parts of the code to make it more simple and readable
 
  
 
====Timeline====
 
====Timeline====
May 23: start of the internship
+
* May 30: start of the internship
 +
* June 3: planning of the project
 +
*'''To be completed'''
 +
* August 26: end of the internship
  
'''FIXME'''
+
===Resources / Contributing===
  
August 31: end of the internship
+
[[Outreachy2022Ideas|Outreachy 2022 Ideas]] - a list of possible contributions
  
===Resources / Contributing===
+
===Archives===
[[Outreachy2022Ideas]] - a list of possible contributions
 
  
===Archives===
+
[[Category:Previous Project]]
[[Category:Project]]
 

Latest revision as of 10:19, 20 June 2024

Summary

Outreachy program provides us two intern for 2022, thanks to the Perlfoundation

The project title : "Improve the code quality of the Perl code of the Open Food Facts backend and website".

Description

Status: planning

People: Raquel DiPietro, Yukti Sharma and mentors: Alex-off and Stephane

Impact (why)

Improving Perl code quality and documentation is a great way to help the project move forward at a faster pace in the future.

Having less bugs also greatly improves the user and contributors experience.

Having a cleaner code, may also help having more contributions to the perl code base.

Expected outcomes (what)

Improve code quality by:

  • adding unit tests to functions that lack them
  • adding integration tests
  • investigating the cause of warnings (e.g. unitialized variables) and fixing them
  • possibly refactoring some parts of the code to make it more simple and readable

Timeline

  • May 30: start of the internship
  • June 3: planning of the project
  • To be completed
  • August 26: end of the internship

Resources / Contributing

Outreachy 2022 Ideas - a list of possible contributions

Archives