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.

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

Update instructions.md #1802

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update instructions.md #1802

wants to merge 1 commit into from

Conversation

dsletten
Copy link

Multiplication (*) incorrectly represented via underscore character.

Multiplication (*) incorrectly represented via underscore character.
@github-actions
Copy link
Contributor

Dear dsletten

Thank you for contributing to the JavaScript track on Exercism! 💙
You will see some automated feedback below 🤖. It would be great if you can make sure your PR covers those points. This will save your reviewer some time and your change can be merged quicker.

  • ⬆️ The instructions and test cases for many practice exercises originate in the Exercism-wide problem-specifications repo. If the exercise you changed is listed there in the exercises folder, please consider the following.

    • Improvements to the instructions.md file should be made in the problem-spec repo so that all tracks can benefit.
      You can open a PR there instead.
    • If you want to add some language specific information, use the instructions.append.md file (see Practice Exercise Docs).
    • Test cases selected in the .meta/tests.toml file need to be implemented in the <exercise>.spec.js file according to the specification in canonical-data.json.
  • ✍️ If your PR is not related to an existing issue (and is not self-explaining like a typo fix), please make sure the description explains why the change you made is necessary.

  • 🔤 If your PR fixes an easy to identify typo, if would be great if you could check for that typo in the whole repo. For example, if you found Unicdoe, use "replace all" in your editor (or command line magic) to fix it consistently.

Dear Reviewer/Maintainer

  • 📏 Make sure you set the appropriate x:size label for the PR. (This also works after merging, in case you forgot about it.)

  • 🔍 Don't be too nit-picky. If the PR is a clear improvement compared to the status quo, it should be approved as clear signal this is good to be merged even if the minor comments you might have are not addressed by the contributor. Further improvement ideas can be captured in issues (if important enough) and implemented via additional PRs.

  • 🤔 After reviewing the diff in the "Files changed" section, take a moment to think about whether there are changes missing from the diff. Does something need to be adjusted in other places so the code or content stays consistent?

Automated comment created by PR Commenter 🤖.

Copy link
Member

@SleeplessByte SleeplessByte left a comment

Choose a reason for hiding this comment

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

Unfortunately this won't work, because the auto formatter will reformat it.

The way to solve this is to update this file against the common file, which escapes the * characters. You can do this manually or follow the sync description.md instructions in our CONTRIBUTING.md file.

Would you be so kind to apply the further change? I'll run the CI for you so you can see why this PR doesn't work as is.

@dsletten
Copy link
Author

Hi,
I don't understand what the problem is. The text shows up properly in other tracks.

@junedev
Copy link
Member

junedev commented Jun 27, 2022

@dsletten As you can see in the CI checks, your proposed version does not pass the formatting check that is done for this tracks repository. Not all tracks do automated formatting checks, this is why your version might not cause issues in other tracks.

The formatter we use thinks you want to create italic text with the * and wants that you correct it to use underscore instead. Running auto-formatting will do this change and this is probably how the issue in the current version appeared in the first place.

SleeplessByte described above how you can avoid this issue so that your code can pass the formatting check and there will not be any issue in case someone runs auto-formatting on the code base. Would be great if you could follow the suggestion so we can get this merged.

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.

3 participants