Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add info for contributors #77

Merged
merged 2 commits into from
Mar 24, 2024
Merged

Add info for contributors #77

merged 2 commits into from
Mar 24, 2024

Conversation

laniakea64
Copy link
Collaborator

Tag #75

Add recipe to verify that (most) test cases are runnable justfiles

... and explicitly list the exceptions.

The primary purpose of vim-just is to highlight correct justfile syntax. And our highlighting is not strictly limited to documented forms of just syntaxes, we try highlight how just actually behaves. So having most test cases be valid, runnable justfiles is helpful in development.

This recipe hints to contributors that keeping most test cases actually runnable is of value to the project, and the exception list documents which ones are not intended to be runnable.

Add some explanatory comments to syntax/just.vim

Document a few things that maybe subtle, to help awareness for contributors looking at those areas of the code.

@laniakea64 laniakea64 requested a review from NoahTheDuke March 24, 2024 00:50
@NoahTheDuke
Copy link
Owner

I didn't write any of the test cases with the intention that they'd be runnable, just that they'd verify a specific shape->highlight. I think that keeping them generally runnable (which is to say, they don't error when you run them to print the list of recipes) is smart tho.

@laniakea64 laniakea64 merged commit 9506b05 into main Mar 24, 2024
1 check passed
@laniakea64 laniakea64 deleted the contrib-technical branch March 24, 2024 02:55
@laniakea64 laniakea64 mentioned this pull request Apr 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants