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

Renamed infra-tester config file #20

Merged
merged 1 commit into from
Sep 11, 2023
Merged

Conversation

fwolfheimer
Copy link
Collaborator

Using a hidden file is less confusing as it doesn't clutter the source directories. Tools like pre-commit and other test tools follow the same approach. Also use the name "infra-tester" in the file name which clearly connects the configuration to the tool.

Updated code and docs.

Use a hidden file is less confusing as it doesn't clutter
the source directories. Tools like pre-commit and other
test tools follow the same approach. Also use the name
"infra-tester" in the file name which clearly connects the
configuration to the tool.
@fwolfheimer fwolfheimer added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 8, 2023
Copy link
Collaborator

@najose najose left a comment

Choose a reason for hiding this comment

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

This has been in my mind for some time now. Naming it config.yaml made it easy to conflict with any other config.yaml and that would make it impossible to use infra-tester unless users renamed the other config.yaml. Naming it .infra-tester-config.yaml sounds perfect as it follows the standard .<util>-config.yaml + makes it hidden. Thanks a lot for this PR!

@najose najose merged commit 44d362b into main Sep 11, 2023
12 checks passed
@najose najose deleted the rename-infra-tester-config-file branch September 11, 2023 04:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants