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 recommendation for key naming? #69

Open
psss opened this issue Jan 15, 2020 · 1 comment
Open

Add recommendation for key naming? #69

psss opened this issue Jan 15, 2020 · 1 comment

Comments

@psss
Copy link
Collaborator

psss commented Jan 15, 2020

Currently there is no recommendation about how an attribute key should look like. For example if there is a need for key consisting of multiple words what would be the best choice?

Keeping spaces? Which could possibly cause problems if not handled properly?

/smoke:
    summary: Basic smoke test
    tcms id: TC#1234567

Substituting them with dashes?

/smoke:
    summary: Basic smoke test
    tcms-id: TC#1234567

Or underscores?

/smoke:
    summary: Basic smoke test
    tcms_id: TC#1234567

Or give no recommendation at all? Ideas?

@AloisMahdal
Copy link
Contributor

AloisMahdal commented Jan 15, 2020

no recommendation at all

because it must be obvious to most what is the correct_way, adn the rest is doomed :)

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

No branches or pull requests

2 participants