Skip to content

[Documentation:Developer] linting docs w/ twig, yaml, .sh, ruff - #796

Open
roye2 wants to merge 5 commits into
mainfrom
update-submitty-test-docs
Open

roye2 wants to merge 5 commits into
mainfrom
update-submitty-test-docs

Conversation

@roye2

@roye2 roye2 commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

Why is this Change Important & Necessary?

In Submitty/Submitty PR #13297, linting with ShellCheck was added to submitty_test.
In Submitty/Submitty PR #13302, linting for twig files was added to submitty_test.
In Submitty/Submitty PR #13301, linting for yaml / yml files was added to submitty_test.
In Submitty/Submitty PR #13299, we switched our python linter / formatter to ruff.

These new features needed to be documented in the Linting and Static Analysis instructions for developers.

What is the New Behavior?

New documentation has been added for developers about the new linting options.

image image image

What steps should a reviewer take to reproduce or test the bug or new feature?

Verify that all wording / instruction is correct and understandable.

@roye2 roye2 changed the title [Documentation:Developer] update submitty_test with twig, yaml, shell [Documentation:Developer] update submitty_test w/ twig, yaml, .sh Oct 2, 2026

@plzzwork plzzwork left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Py-flake8 and py-pylint are no longer tests for Submitty_test. These two have been changed to py-lint and py-format which run the ruff check and ruff format respectively. Lines 163 and 164 do not have twig-lint in front of the modifiers. Line 164 was not able to read the listed twig file. twig-line --show-deprecation worked fine. Both shell-lint and yaml-lint worked.

@roye2 roye2 changed the title [Documentation:Developer] update submitty_test w/ twig, yaml, .sh [Documentation:Developer] linting docs w/ twig, yaml, .sh, ruff Oct 13, 2026
@roye2
roye2 requested a review from plzzwork October 13, 2026 22:34
@roye2

roye2 commented Oct 13, 2026

Copy link
Copy Markdown
Contributor Author

Py-flake8 and py-pylint are no longer tests for Submitty_test. These two have been changed to py-lint and py-format which run the ruff check and ruff format respectively. Lines 163 and 164 do not have twig-lint in front of the modifiers. Line 164 was not able to read the listed twig file. twig-line --show-deprecation worked fine. Both shell-lint and yaml-lint worked.

You can add comments to specific lines!


__Minimum Version__: 3.8

For Python, we use [flake8](http://flake8.pycqa.org/en/latest/) and [pylint](https://pylint.readthedocs.io/en/stable/)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@plzzwork this is an example of a comment corresponding to a line

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Work in Progress

Development

Successfully merging this pull request may close these issues.

2 participants