disnake icon indicating copy to clipboard operation
disnake copied to clipboard

fix(docs): remove symlinks, update lint config

Open shiftinv opened this issue 3 years ago • 0 comments
trafficstars

Summary

This removes the two symlinks currently present in the repo that are being used for linking related issue/PR IDs in the changelog. Since symlinks generally don't work on Windows, we unfortunately have to get rid of them as they'll make contributing more difficult.

Instead, these files that were previously symlinks now just have the same content as the files they were linking to, leading to the same result in the built changelog (as towncrier groups entries based on content). While this isn't a great solution, it's the only one (short of forking towncrier), as there isn't any way of hooking into the changelog generation process.

Also adds a pre-commit hook that prevents symlinks from being committed to the repo in the future.

Checklist

  • [x] If code changes were made, then they have been tested
    • [ ] I have updated the documentation to reflect the changes
    • [ ] I have formatted the code properly by running task lint
    • [ ] I have type-checked the code by running task pyright
  • [x] This PR fixes an issue
  • [ ] This PR adds something new (e.g. new method or parameters)
  • [ ] This PR is a breaking change (e.g. methods or parameters removed/renamed)
  • [ ] This PR is not a code change (e.g. documentation, README, ...)

shiftinv avatar Aug 11 '22 17:08 shiftinv