Skip to content
  • Steffen Wentzel's avatar
    fix SPA handler in README.md (#733) · 3401478b
    Steffen Wentzel authored
    <!--
    For Work In Progress Pull Requests, please use the Draft PR feature,
    see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for
    further details.
    
         For a timely review/response, please avoid force-pushing additional
         commits if your PR already received reviews or comments.
    
         Before submitting a Pull Request, please ensure that you have:
    - 📖 Read the Contributing guide:
    https://github.com/gorilla/.github/blob/main/CONTRIBUTING.md
    - 📖 Read the Code of Conduct:
    https://github.com/gorilla/.github/blob/main/CODE_OF_CONDUCT.md
    
         - Provide tests for your changes.
         - Use descriptive commit messages.
    	 - Comment your code where appropriate.
    	 - Squash your commits
         - Update any related documentation.
    
         - Add gorilla/pull-request-reviewers as a Reviewer
    -->
    
    ## What type of PR is this? (check all applicable)
    
    - [ ] Refactor
    - [ ] Feature
    - [ ] Bug Fix
    - [ ] Optimization
    - [X] Documentation Update
    - [ ] Go Version Update
    - [ ] Dependency Update
    
    ## Description
    
    Changed the SPA handler example in README.md in two areas. First, made
    sure to actually include the requested path in the call to
    `filepath.Join`. Secondly, if the requested path hits a directory, I
    think it would be beneficial to also serve the `indexPath` file, and not
    list the directory contents. I also edited the comments in the
    `README.md` file accordingly.
    
    ## Related Tickets & Documents
    
    <!--
    For pull requests that relate or close an issue, please include them
    below. We like to follow [Github's guidance on linking issues to pull
    requests](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
    
    For example having the text: "closes #1234" would connect the current
    pull
    request to issue 1234.  And when we merge the pull request, Github will
    automatically close the issue.
    -->
    
    - Related Issue #
    - Closes #
    
    ## Added/updated tests?
    
    - [ ] Yes
    - [X] No, and this is why: I only changed the `README.md`, if any tests
    are necessary please let me know
    - [ ] I need help with writing tests
    
    ## Run verifications and test
    
    - [ ] `make verify` is passing
    - [ ] `make test` is passing
    3401478b