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

[Feature]: Customizable Front Content #37

Open
8 tasks
mkuehn opened this issue Dec 10, 2024 · 2 comments
Open
8 tasks

[Feature]: Customizable Front Content #37

mkuehn opened this issue Dec 10, 2024 · 2 comments
Labels
enhancement New feature or request triage Issues to be triaged

Comments

@mkuehn
Copy link

mkuehn commented Dec 10, 2024

Description

It would be fun to be able to customize the skyline with a company logo, etc. to personalize it for gift giving!

There may be cases where the user would want to exclude the year information from the front of the model (for example, when including an image and a date range of the user's entire history, maybe they'd just want to show the company logo in place of the date range)

Requirements

  • add a flag to include a image file that can be included in the rendering of the information on the front of the skyline
  • change the y flag/add new flag to also be able to exclude all year information from the face of the model

Definition of Done

  • When a valid image file reference is passed with the image flag
    • it is rendered on the front of the skyline
    • it has the same depth as the invertocat
    • it is aligned to the right of the front of the skyline
    • if white space is present on the right of the image file, it is respected so that white space in the image file can be used to offset the image from the right side of the face of the skyline
    • if white space is present on the right of the image file AND the year is included on the face of the skyline, the white space is respected so that it can be used to center the image between the username and year
      • optionally, a flag to control the positioning of the image (center between username and year or right edge, right align with margin. etc.)
  • When the y flag is used for exclusion, the year information is omitted on the model face

Additional Notes

No response

@mkuehn mkuehn added enhancement New feature or request triage Issues to be triaged labels Dec 10, 2024
@github-project-automation github-project-automation bot moved this to Needs Review in gh-skyline Dec 10, 2024
@chrisreddington
Copy link
Collaborator

Thanks for raising this issue @mkuehn 🙏 This is an interesting feature request, and seems to align with an overarching theme with other issues raised around customisation of the generated skyline 😄

I think I can see the use case, but would like to rubber duck a little bit further. What about a scenario where a user wants to print their Skyline annually (with the image example you suggest), how would they differentiate between different years?

@chrisreddington chrisreddington removed their assignment Dec 10, 2024
@chrisreddington chrisreddington added triage Issues to be triaged and removed triage Issues to be triaged labels Dec 10, 2024
@mkuehn
Copy link
Author

mkuehn commented Dec 11, 2024

I think I can see the use case, but would like to rubber duck a little bit further. What about a scenario where a user wants to print their Skyline annually (with the image example you suggest), how would they differentiate between different years?

Sure, the year shouldn't always be excluded, just available to be excluded if the user wants. In your scenario, I guess they wouldn't be able to know which print was from which year. Or maybe they'd just recycle last year's print when they run a new one. :-) Or, they could keep the year, whatever they like.

So, you should be able to do any of the following, as you like:

--------------------------------------------------------------------------------
[github logo] @username                                    [company logo] 2024 |
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
[github logo] @username                                                   2024 |
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
[github logo] @username                                         [company logo] |
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
[github logo] @username                  [company logo]                   2024 |
--------------------------------------------------------------------------------

Hope that clears up what I meant!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request triage Issues to be triaged
Projects
Status: Needs Review
Development

No branches or pull requests

2 participants