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 about.md in About Slices concept #2278

Merged
merged 3 commits into from
Sep 24, 2022

Conversation

Inkognitoo
Copy link
Contributor

Add information about merging slices with append

Add information about merging slices with append
@github-actions
Copy link
Contributor

github-actions bot commented Jul 1, 2022

Dear Inkognitoo

Thank you for contributing to the Go 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 following files usually contain very similar content.

    • concepts/<concept>/about.md
    • concepts/<concept>/introduction.md
    • exercises/concept/<exercise>/.docs/introduction.md

    Please check whether the changes you made to one of these also need to be applied to the others.

  • 🔗 If your PR fully fixes an issue, please include the text Fixes #issue_no in any line of the PR description. This will make the issue be automatically be closed when the PR is merged. If your PR is related to an existing issue but does not fix it completely, please link the issue anywhere in the description of the PR with #issue_no. You can read more about this in Github: Linking a pull request to an issue

  • ✍️ 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

@andrerfcsantos andrerfcsantos left a comment

Choose a reason for hiding this comment

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

Thanks for this!

I think this is a great change since the exercise directly requires this and you kept it brief.

You made this change in about.md which is fine, but this file is only shown when the student completes the exercise/concept, which is late to show this information. My suggestion is to also make this change in the concept's introduction concepts/slices/introduction.md and in the exercise's introduction exercises/concept/card-tricks/.docs/introduction.md just so the student is shown this explanation before attempting the exercise.

The exercise's introduction also includes a simpler example on how to use append with multiple arguments without using the ... notation. I think we should also include that in this explanation:

a := []int{1, 3}
b := append(a, 4, 2) // b == []int{1,3,4,2}

I'll let you choose how you want to incorporate this example in the explanation, but I'm thinking of maybe having a paragraph + code sample explaining this simple example first and then another paragraph + code sample explaining the ... notation. And to be clear, this extra example should be included in the 3 files, not just in the exercise's introduction.

concepts/slices/about.md Outdated Show resolved Hide resolved
concepts/slices/about.md Outdated Show resolved Hide resolved
concepts/slices/about.md Outdated Show resolved Hide resolved
@andrerfcsantos andrerfcsantos added status/awaiting-contributor This pull request is waiting on the contributor. x:rep/small Small amount of reputation labels Jul 4, 2022
@andrerfcsantos
Copy link
Member

@Inkognitoo Let us know if you are still interested in working on this. It's totally fine if you are not, we can finish this for you. If you are still interested in working on this feel free to take your time, there's no rush.

@exercism exercism deleted a comment from github-actions bot Sep 23, 2022
@exercism exercism deleted a comment from github-actions bot Sep 23, 2022
Copy link
Member

@andrerfcsantos andrerfcsantos left a comment

Choose a reason for hiding this comment

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

It has been a while. Since the changes of this PR were small and the suggestions easy to implement, I made the final changes to finish the PR.

Thanks!

@andrerfcsantos andrerfcsantos merged commit 77516b3 into exercism:main Sep 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status/awaiting-contributor This pull request is waiting on the contributor. x:rep/small Small amount of reputation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants