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

[Proposal] Improve file names #29

Open
erikhofer opened this issue Mar 17, 2022 · 1 comment
Open

[Proposal] Improve file names #29

erikhofer opened this issue Mar 17, 2022 · 1 comment

Comments

@erikhofer
Copy link
Member

Current file names have the form issue-42.yml which directly relates to the item ID.

Disadvantages:

  • Does not give a clue about the file content beside the item type
  • Files are not sorted correctly because there are no leading zeroes

Proposal: file names of the form 00042-slug-form-of-the-title.yml. The ID for references would still be issue-42 and can be derived from the file name and directory. This would also allow for shorter refs like "imp" (improvement) and "req" (requirement).

Disadvantages:

  • ID is not directly visible from the file name
  • IDs are not automatically unique, we have to verify this
  • If the title changes, the slug may not be suitable anymore. I think we should not provide a UI for editing slugs for now. They can always be edited manually if desired. This would also not break refs because we use IDs for this.

(Related to #11)

@erikhofer
Copy link
Member Author

Experience in real-life project: item titles are changed regularly. Sometimes wording is improved slightly, sometimes the title is changed copletely in the course of iterative refinement. At the moment, it feels good to not have to worry about file names and evolve titles freely.

@erikhofer erikhofer changed the title Improve file names [Proposal] Improve file names May 3, 2022
@erikhofer erikhofer removed this from the Beta release milestone Sep 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

1 participant