Short projects: Difference between revisions
Jump to navigation
Jump to search
m (→Easy Closes: remove closed bug) |
|||
| (29 intermediate revisions by 7 users not shown) | |||
| Line 14: | Line 14: | ||
== Implement missing Matlab functions == | == Implement missing Matlab functions == | ||
Use the [https://savannah.gnu.org/patch/?func=additem&group=octave Savannah patch tracker] for submissions unrelated to an existing bug. | * Use the [https://savannah.gnu.org/patch/?func=additem&group=octave Savannah patch tracker] for submissions unrelated to an existing bug. | ||
== Test Octave functions for proper input handling == | |||
* Many functions either do insufficient input checking or the input requirements have changed over time. | |||
* Contributors can try to break Octave function behavior with different types of input, and document the results. | |||
* Users can check <em>expected behavior</em> according to the Octave help and, if applicable, expected compatible behavior according to [https://www.mathworks.com/help/matlab/ public facing Matlab documentation]. | |||
* Inputs to test can be: | |||
** different numeric types - double, single, integer. | |||
** non-numeric types - logical, string, cell, struct | |||
** different input shapes - scalar, row/column vectors, 2D, 3D, & nD arrays, zero size arrays ([], 1x0, and 1x3x0 are all empty but may require different handling). | |||
** char/string parameters: different case handling, partial matching behavior, invalid/nonsense parameters. | |||
* For the input items above, does function behave acceptably? Are numerical or graphical outputs as expected? Is output consistent? Is any error message intelligible/meaningful to the user? | |||
* Optionally the behavior above can be tested against Matlab function output if it is available. If needed but not available, tests can be submitted to other developers for output checking. | |||
** Note 1: There is much undocumented Matlab behavior. Because this has the possibility of changing with little notice, fixing incompatibilities related to such undocumented behavior is considered on a case-by-case basis by the developer team. Documentation of such cases is always beneficial, however. | |||
** Note 2: Only Matlab public documentation and function output may be compared. <em>Internal Matlab code, even if available, should never even be looked at by a contributor. Contributions will be discarded if it is determined such action occurred.</em> | |||
* Contributors can submit bug reports to the [https://savannah.gnu.org/bugs/?group=octave Octave Bug Tracker] documenting their findings. | |||
* An example can be see in bug {{bug|64078}} comment #10 of looking through the /plot/draw functions for how they handle integer and logical inputs to numeric fields. | |||
== Write Built-In Self Tests (BISTs) == | == Write Built-In Self Tests (BISTs) == | ||
| Line 28: | Line 46: | ||
== Easy Closes == | == Easy Closes == | ||
Below is a non exhaustive list of bugs which should be looked at and appear to be easy | Below is a non exhaustive list of bugs which should be looked at and appear to be easy. Completed scrub using 6.1 as non expert. Status column provides notes from last review to facilitate addressing each bug. (Reviewing and updating status of items in this list as well as adding new ones are themselves good beginner tasks.) | ||
Status ( | |||
Notes: | Notes: | ||
*The last full scrub came from hardy for v4.2 | *The last full scrub came from hardy for v4.2 | ||
*Suspect many | *Suspect many java bugs could be closed. | ||
*Appears plotting bugs have been fixed, but not have been reviewed for 5 years. | |||
*Did not include most documentation bugs. | |||
*Experts: rik5, nrjank, etc. will be able to find significantly more to close. | |||
{| class="wikitable" | {| class="wikitable" | ||
| Line 39: | Line 59: | ||
! bug !! bug title !! status | ! bug !! bug title !! status | ||
|- | |- | ||
| {{bug|36954}} || datenum / datevec convert date-time string incorrectly during hour lost to DST || siko1056 suggests closing as won't fix | | {{bug|36954}} || datenum / datevec convert date-time string incorrectly during hour lost to DST || siko1056 suggests closing as won't fix. nrjank reverted from Postponed to Confirmed / removed Assigned To tag after dormant for 2 years. | ||
|- | |- | ||
| {{bug| | | {{bug|40357}} || OOM when converting from sparse double to sparse logical|| hardy thinks this might be a DUPLICATE, nrjank changed to Need Info, needs better test to determine if the OOM comes from known sparse indexing issue or something else. | ||
|- | |- | ||
| {{bug| | | {{bug|48088}} || document that issquare, iscolumn, isempty, etc operate on cell arrays|| documentation patch candidate submitted and needs review. | ||
|- | |- | ||
| {{bug| | | {{bug|49886}} || ezplot: octave does not warn when function not vectorized || Rik states This would be easy to fix if {{bug|42691}} was first solved. That bug was closed as fixed in August 2021, so supposedly this one should now be easier manageable. nrjank marked as Needs Info to determine if desired output is just adding a warning, or also matching matlab output. | ||
|- | |- | ||
| {{bug| | | {{bug|49360}} || odeset lacks documentation for solver options || Needs someone to review and make a to-do list. | ||
|- | |- | ||
| {{bug| | | {{bug|53214}} || area.m needs update to implement ShowBaseline and other properties || nrjank states last remaining task is adjusting the axis limits to fit the data. This has been pushed for area.m. Left remaining is whether to do the same for plot.m which would require checking on/fixing failing tests in other functions. | ||
|- | |- | ||
| {{bug| | | {{bug|54437}} || optimset missing documentation for 5 options || Documentation task. rik states AutoScaling, ComplexEqn, and Updating can be copied from fsolve.m so this would be an improvement. | ||
|- | |- | ||
| {{bug| | | {{bug|55065}} || Implement uiopen and uisave || both a patch and m-file versions of the two functions have been separately submitted. they both need to be evaluated for fitness. | ||
|- | |- | ||
| {{bug| | | {{bug|56208}} || GUI Editor autocomplete list could show variables from current workspace || suggested it might be fixed, but appears to still not be meeting summary requst. marked as Needs Info | ||
|- | |- | ||
| {{bug| | | {{bug|57352}} || text height for blank line should approximate that of ordinary character || initial patch suggestion provided but still needs some trial and error to get good height behavior | ||
|- | |- | ||
| {{bug|58530}} || missing functions: xline() and yline() || initial patch submitted in 2022, needs rework according to rik's comments | |||
| {{bug|58530}} || missing functions: xline() and yline() || rik | |||
|} | |} | ||
| Line 109: | Line 86: | ||
|- | |- | ||
! patch !! patch title !! status | ! patch !! patch title !! status | ||
|- | |- | ||
|} | |} | ||
A list of patch reports with attachments not marked "Done or Cancelled" can be viewed in the SavannaAPI, [https://octave.space/savannah/api.php?Action=get&Format=HTMLCSS&OrderBy=SubmittedOn&OpenClosed=open&TrackerID=patch&AttachedFiles!=0&Category!=Forge,website&Status!=Done,Cancelled sorted by oldest first] or [https://octave.space/savannah/api.php?Action=get&Format=HTMLCSS&OrderBy=LastComment&OpenClosed=open&TrackerID=patch&AttachedFiles!=0&Category!=Forge,website&Status!=Done,Cancelled sorted by "longest since last comment" first]. While some of these older submissions may still be viable and just need a patch refresh to the current code base, many will have become out of date or rendered inapplicable due to code or function changes, and could be closed as 'Wont Fix'. | |||
== See also == | == See also == | ||
Latest revision as of 18:35, 14 September 2023
- This is a collection of small projects to start contributing to Octave. Projects of long duration are listed in the Projects page.
If you never contributed to Octave before, we suggest to start with our Developer FAQ.
Review and fix existing bugs[edit]
- Review bugs that catch your interest on the Octave bug tracker on GNU Savannah.
- A modern interface to the Octave bug tracker is given by SavannahAPI.
- Discuss with the developers there how to fix that bug or upload a patch there.
- Some bugs have already patches attached.
- Help testing those patches.
- Help updating outdated patches to the latest development version (this requires some Mercurial knowledge).
Implement missing Matlab functions[edit]
- Use the Savannah patch tracker for submissions unrelated to an existing bug.
Test Octave functions for proper input handling[edit]
- Many functions either do insufficient input checking or the input requirements have changed over time.
- Contributors can try to break Octave function behavior with different types of input, and document the results.
- Users can check expected behavior according to the Octave help and, if applicable, expected compatible behavior according to public facing Matlab documentation.
- Inputs to test can be:
- different numeric types - double, single, integer.
- non-numeric types - logical, string, cell, struct
- different input shapes - scalar, row/column vectors, 2D, 3D, & nD arrays, zero size arrays ([], 1x0, and 1x3x0 are all empty but may require different handling).
- char/string parameters: different case handling, partial matching behavior, invalid/nonsense parameters.
- For the input items above, does function behave acceptably? Are numerical or graphical outputs as expected? Is output consistent? Is any error message intelligible/meaningful to the user?
- Optionally the behavior above can be tested against Matlab function output if it is available. If needed but not available, tests can be submitted to other developers for output checking.
- Note 1: There is much undocumented Matlab behavior. Because this has the possibility of changing with little notice, fixing incompatibilities related to such undocumented behavior is considered on a case-by-case basis by the developer team. Documentation of such cases is always beneficial, however.
- Note 2: Only Matlab public documentation and function output may be compared. Internal Matlab code, even if available, should never even be looked at by a contributor. Contributions will be discarded if it is determined such action occurred.
- Contributors can submit bug reports to the Octave Bug Tracker documenting their findings.
- An example can be see in bug #64078 comment #10 of looking through the /plot/draw functions for how they handle integer and logical inputs to numeric fields.
Write Built-In Self Tests (BISTs)[edit]
Writing BISTs improves Octave's regression testing and ensures that we don't break anything when we add new features.
- BIST for C++ functions
- BIST for m-files. See also Projects#Tests.
Work on Octave packages[edit]
- Take a look at https://gnu-octave.github.io/packages/ if you would like to work on some package there.
Easy Closes[edit]
Below is a non exhaustive list of bugs which should be looked at and appear to be easy. Completed scrub using 6.1 as non expert. Status column provides notes from last review to facilitate addressing each bug. (Reviewing and updating status of items in this list as well as adding new ones are themselves good beginner tasks.)
Notes:
- The last full scrub came from hardy for v4.2
- Suspect many java bugs could be closed.
- Appears plotting bugs have been fixed, but not have been reviewed for 5 years.
- Did not include most documentation bugs.
- Experts: rik5, nrjank, etc. will be able to find significantly more to close.
| bug | bug title | status |
|---|---|---|
| #36954 | datenum / datevec convert date-time string incorrectly during hour lost to DST | siko1056 suggests closing as won't fix. nrjank reverted from Postponed to Confirmed / removed Assigned To tag after dormant for 2 years. |
| #40357 | OOM when converting from sparse double to sparse logical | hardy thinks this might be a DUPLICATE, nrjank changed to Need Info, needs better test to determine if the OOM comes from known sparse indexing issue or something else. |
| #48088 | document that issquare, iscolumn, isempty, etc operate on cell arrays | documentation patch candidate submitted and needs review. |
| #49886 | ezplot: octave does not warn when function not vectorized | Rik states This would be easy to fix if #42691 was first solved. That bug was closed as fixed in August 2021, so supposedly this one should now be easier manageable. nrjank marked as Needs Info to determine if desired output is just adding a warning, or also matching matlab output. |
| #49360 | odeset lacks documentation for solver options | Needs someone to review and make a to-do list. |
| #53214 | area.m needs update to implement ShowBaseline and other properties | nrjank states last remaining task is adjusting the axis limits to fit the data. This has been pushed for area.m. Left remaining is whether to do the same for plot.m which would require checking on/fixing failing tests in other functions. |
| #54437 | optimset missing documentation for 5 options | Documentation task. rik states AutoScaling, ComplexEqn, and Updating can be copied from fsolve.m so this would be an improvement. |
| #55065 | Implement uiopen and uisave | both a patch and m-file versions of the two functions have been separately submitted. they both need to be evaluated for fitness. |
| #56208 | GUI Editor autocomplete list could show variables from current workspace | suggested it might be fixed, but appears to still not be meeting summary requst. marked as Needs Info |
| #57352 | text height for blank line should approximate that of ordinary character | initial patch suggestion provided but still needs some trial and error to get good height behavior |
| #58530 | missing functions: xline() and yline() | initial patch submitted in 2022, needs rework according to rik's comments |
The equivalent suggestions for patches.
| patch | patch title | status |
|---|
A list of patch reports with attachments not marked "Done or Cancelled" can be viewed in the SavannaAPI, sorted by oldest first or sorted by "longest since last comment" first. While some of these older submissions may still be viable and just need a patch refresh to the current code base, many will have become out of date or rendered inapplicable due to code or function changes, and could be closed as 'Wont Fix'.