Skip to content

chore: renaming index files #1397

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

Merged
merged 1 commit into from
May 11, 2022
Merged

chore: renaming index files #1397

merged 1 commit into from
May 11, 2022

Conversation

Kira-Pilot
Copy link
Member

@Kira-Pilot Kira-Pilot commented May 11, 2022

Renaming index files to something (a bit) more specific. Resolves #1211.
I actually couldn't find that many instances - only the two mentioned in the ticket. I figured we didn't want to rename barrel files or our index page but if you see something, say something!

@Kira-Pilot Kira-Pilot requested review from presleyp and a team as code owners May 11, 2022 20:25
@codecov
Copy link

codecov bot commented May 11, 2022

Codecov Report

Merging #1397 (6e1c7db) into main (982769f) will increase coverage by 0.15%.
The diff coverage is 75.00%.

@@            Coverage Diff             @@
##             main    #1397      +/-   ##
==========================================
+ Coverage   66.90%   67.06%   +0.15%     
==========================================
  Files         288      287       -1     
  Lines       18857    18850       -7     
  Branches      241      241              
==========================================
+ Hits        12616    12641      +25     
+ Misses       4949     4924      -25     
+ Partials     1292     1285       -7     
Flag Coverage Δ
unittest-go-macos-latest 54.11% <ø> (+0.08%) ⬆️
unittest-go-postgres- 65.51% <ø> (+0.14%) ⬆️
unittest-go-ubuntu-latest 56.45% <ø> (-0.06%) ⬇️
unittest-go-windows-2022 52.37% <ø> (+<0.01%) ⬆️
unittest-js 74.24% <75.00%> (ø)
Impacted Files Coverage Δ
site/src/api/api.ts 70.00% <ø> (ø)
site/src/pages/CliAuthPage/CliAuthPage.tsx 0.00% <0.00%> (ø)
...anizationPage/TemplatePage/CreateWorkspacePage.tsx 0.00% <0.00%> (ø)
site/src/testHelpers/renderHelpers.tsx 100.00% <ø> (ø)
site/src/xServices/auth/authXService.ts 82.60% <100.00%> (ø)
site/src/xServices/buildInfo/buildInfoXService.ts 71.42% <100.00%> (ø)
site/src/xServices/roles/siteRolesXService.ts 80.00% <100.00%> (ø)
site/src/xServices/terminal/terminalXService.ts 68.42% <100.00%> (ø)
site/src/xServices/users/usersXService.ts 72.91% <100.00%> (ø)
site/src/xServices/workspace/workspaceXService.ts 59.09% <100.00%> (ø)
... and 13 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 982769f...6e1c7db. Read the comment docs.

Copy link
Contributor

@greyscaled greyscaled left a comment

Choose a reason for hiding this comment

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

Looks great!

One suggestion is to Link your PR to the issue so that it automatically closes when it merges.

There's 2 standard ways to do this, I suggest both:

  1. Adding a body to your commit message
chore: renaming index files

resolves: #1211 
  1. Adding the same in your PR description

I think we forgot to mention this anywhere in our onboarding docs, especially because we used to use an external tracker where we got this for free through the branch name.

Hope that helps!

@Kira-Pilot
Copy link
Member Author

One suggestion is to Link your PR to the issue so that it automatically closes when it merges.

Gotcha! Adjusted the description and will do going forward - thanks for the link.

@Kira-Pilot Kira-Pilot merged commit f93804a into main May 11, 2022
@Kira-Pilot Kira-Pilot deleted the rename-index-files/kira-pilot branch May 11, 2022 21:02
kylecarbs pushed a commit that referenced this pull request Jun 10, 2022
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

Successfully merging this pull request may close these issues.

Rename remaining index files
2 participants