`copilot`: Typo in README (zephir vs zephyr)

[ivanperez-keera]

Description

copilot's README mentions a project zephir-copilot that is actually called zephyr-copilot.

This typo should be corrected.

Type

• Bug: incorrect documentation.

Additional context

None.

Requester

• Ivan Perez

Method to check presence of bug

Running a search through the tree brings up the mention:

$ grep -niHre 'Zephir'
copilot/README.md:225:- [zephir-copilot](https://hackage.haskell.org/package/zephyr-copilot)

Expected result

The output of the above grep command should be empty, indicating that the incorrect spelling cannot be found.

Desired result

The output of the above grep command should be empty, indicating that the incorrect spelling cannot be found.

Proposed solution

Fix the above mentioned typo.

Further notes

None.

[ivanperez-keera]

Change Manager: Confirmed that the spelling zephir is present in the README and that it is a typo (the package name is indeed zephyr-copilot).

[ivanperez-keera]

Technical Lead: Confirmed that the issue should be addressed.

[ivanperez-keera]

Technical Lead: Bug scheduled for fixing in Copilot 3.17.

Fix assigned to: @ivanperez-keera.

[ivanperez-keera]

Implementor: Solution implemented, review requested.

[ivanperez-keera]

Change Manager: Verified that:

• Solution is implemented:

  • The code proposed compiles and passes all tests. Details:
    Build log: https://app.travis-ci.com/github/Copilot-Language/copilot/builds/267041873

  • The solution proposed produces the expected result. Details:
    The following Dockerfile checks that the misspelling Zephyr has been completely removed from the repo. When executed, it prints the message Success if the misspelled word cannot be found, and the word Failure otherwise.

  FROM ubuntu:focal
  
  ENV DEBIAN_FRONTEND=noninteractive
  RUN apt-get update
  RUN apt-get install --yes git moreutils
  RUN git config --global advice.detachedHead false
  
  SHELL ["/bin/bash", "-c"]
  CMD git clone --quiet $REPO \
      && cd $NAME \
      && git checkout --quiet $COMMIT \
      && (grep -rie 'zephir' copilot** | ifne false) \
      && echo "Success" || echo "Failure"

  Command (substitute variables based on new path after merge):

  $ docker run -e "REPO=https://github.com/ivanperez-keera/copilot" -e "NAME=copilot" -e "COMMIT=2310f70da905ce721dfe6d9b25b023b584615490" -it copilot-verify-459
  

• Implementation is documented. Details:
  The change is to the documentation. No changes to the implementation.
• Change history is clear.
• Commit messages are clear.
• Changelogs are updated.
• Examples are updated. Details:
  No updates needed.
• Required version bumps are evaluated. Details:
  Bump not needed (change to documentation not affecting API).

[ivanperez-keera]

Change Manager: Implementation ready to be merged.