Difference between revisions of "Coding Standards"
Jump to navigation
Jump to search
(Remove outdated stuff, and reference perltidy) Tag: Replaced |
m |
||
| Line 2: | Line 2: | ||
More detail on the standards will be included in this page in the future. For now a good place to start is to make sure you run perltidy on your code. In particular there is a script at $WEBWORK_ROOT/bin/dev_scripts/run-perltidy to do this. You can reference https://github.com/openwebwork/webwork2/blob/main/.perltidyrc to see what this is doing. |
More detail on the standards will be included in this page in the future. For now a good place to start is to make sure you run perltidy on your code. In particular there is a script at $WEBWORK_ROOT/bin/dev_scripts/run-perltidy to do this. You can reference https://github.com/openwebwork/webwork2/blob/main/.perltidyrc to see what this is doing. |
||
| + | |||
| + | You may need to install a more recent version of perltidy using |
||
| + | <code>sudo cpanm Perl::Tidy</code> to avoid a warning about <code>Unknown option: vxl</code>. |
||
[[Category:Developers]] |
[[Category:Developers]] |
||
Latest revision as of 12:45, 6 April 2023
Submissions to the WeBWorK code are now subject to coding standards, and pull requests that do not meet these standards will not be merged.
More detail on the standards will be included in this page in the future. For now a good place to start is to make sure you run perltidy on your code. In particular there is a script at $WEBWORK_ROOT/bin/dev_scripts/run-perltidy to do this. You can reference https://github.com/openwebwork/webwork2/blob/main/.perltidyrc to see what this is doing.
You may need to install a more recent version of perltidy using
sudo cpanm Perl::Tidy to avoid a warning about Unknown option: vxl.
