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.

Sign up for GitHub

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

Jump to bottom

Should code reference links go to the commit or the branch? #16

Closed
handstandsam opened this issue Jul 3, 2024 · 1 comment
Closed

Should code reference links go to the commit or the branch? #16

handstandsam opened this issue Jul 3, 2024 · 1 comment

Comments

@handstandsam
Copy link
Collaborator

Commit is more exact, and will be there, but it sometimes feels more reassuring that you're pointing the user to code in a specific branch.

🤔

At the moment I switched from branch -> commit. Not sure which way will be better, or if this requires a configuration setting, so I'm creating this issue to track.
handstandsam added a commit that referenced this issue Jul 3, 2024
@handstandsam
Using new extension functions for computing links. Decided to use com…
003d5a1 
…mit shas instead of branches to be more exact. This doesn't work super well when running on a local branch with a random commit... but that's not the typical use case? Created #16 to track.
@handstandsam handstandsam mentioned this issue Jul 3, 2024
Closed
@handstandsam
Copy link
Collaborator Author

It's been decided to link to the commit, but to note the branch that invert was run on. This way all Code References will work, even if there are changes to those files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@handstandsam