Fix exercise README template #162
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This is seriously delicate... I deem it to be the limitation of the templating language =P |
|
Thanks! I'm not familiar with the template language, so I'll have to trust you that it works as you outline it :D The output definitely looks better. Could you run |
Update `config/exercise_readme.go.tmpl` to add in the missing newline in the generated README before `## Source`, and remove the extra newline after that block. The new template ensure that the generated README have consistent single newline in the event of missing `.Hints`, `.TrackInsert`, and/or `.Spec.Credits`. Most READMEs will manually cater for it after generation, but that will make `bin/configlet generate .` be non-idempotent. Also update READMEs that didn't cater for the missing/additional newline, together with the notebooks using them.
|
Ah I see, I guess that's why Travis CI complained. Ok, I've done the fixup as per your recommendation. Thanks much for the review! |
Codecov Report
@@ Coverage Diff @@
## master #162 +/- ##
=======================================
Coverage 96.44% 96.44%
=======================================
Files 104 104
Lines 1042 1042
=======================================
Hits 1005 1005
Misses 37 37Continue to review full report at Codecov.
|
Yep. It's a bit hidden in the log if you don't know that the check exists. |
SaschaMann
added a commit
to ErikSchierboom/julia
that referenced
this pull request
Apr 1, 2021
A few noteworthy changes: * exercism#162 has manually been excluded as it was a mass-PR done by changing a global template * PRs to several exercises that changed the exercise itself were all included * All reviews were included as contribution; reviewers where added where missing; however due to GitHub's UI hiding reviewers in the history, I may have missed reviews done on PRs that weren't on the initial PR of an exercise * 6c8a1db caused weirdness due to having two parents from merging the default branch into the PR branch. This has manually been resolved as well If you feel like you've been removed or added unjustly, let me know and I'll re-add you in a follow-up PR. Sorry if that happened!
SaschaMann
added a commit
that referenced
this pull request
Apr 1, 2021
* Add authors and contributors to Practice Exercises For each Practice Exercise, we've looked at the commit history of its files to see which commits touched that Practice Exercise. Each commit that we could associate with a Practice Exercise was used to determine authorship/contributorship. ### Authors 1. Find the Git commit author of the oldest commit linked to that Practice Exercise 2. Find the GitHub username for the Git commit author of that commit 3. Add the GitHub username of the Git commit author to the `authors` key in the `.meta/config.json` file ### Contributors 1. Find the Git commit authors and any co-authors of all but the oldest commit linked to that Practice Exercise. If there is only one commit, there won't be any contributors. 1. Exclude the Git commit author and any co-authors of the oldest commit from the list of Git commit authors (an author is _not_ also a contributor) 2. Find the GitHub usernames for the Git commit authors and any co-authors of those commits 3. Add the GitHub usernames of the Git commit authors and any co-authors to the `contributor` key in the `.meta/config.json` file We used the GitHub GraphQL API to find the username of a commit author or any co-authors. In some cases though, a username cannot be found for a commit (e.g. due to the user account no longer existing), in which case the commit was skipped. ## Renames There are a small number of Practice Exercises that might have been renamed at some point. You can ask Git to "follow" a file over its renames using `git log --follow <file>`, which will also return commits made before renames. Unfortunately, Git does not store renames, it just stores the contents of the renamed files and tries to guess if a file was renamed by looking at its contents. This _can_ (and will) lead to false positives, where Git will think a file has been renamed whereas it hasn't. As we don't want to have incorrect authors/contributors for exercises, we're ignoring renames. The only exception to this are known exercise renames: - `bracket-push` was renamed to `matching-brackets` - `retree` was renamed to `satellite` - `resistor-colors` was renamed to `resistor-color-duo` - `kindergarden-garden` was renamed to `kindergarten-garden` ## Exclusions There are some commits that we skipped over, and which thus didn't influence the authors/contributors list: - Commits authored by `dependabot[bot]`, `dependabot-preview[bot]` or `github-actions[bot]` - Bulk update PRs made by `ErikSchierboom` or `kytrinx` to update the track * Restore formatting * Manually fix authors A few noteworthy changes: * #162 has manually been excluded as it was a mass-PR done by changing a global template * PRs to several exercises that changed the exercise itself were all included * All reviews were included as contribution; reviewers where added where missing; however due to GitHub's UI hiding reviewers in the history, I may have missed reviews done on PRs that weren't on the initial PR of an exercise * 6c8a1db caused weirdness due to having two parents from merging the default branch into the PR branch. This has manually been resolved as well If you feel like you've been removed or added unjustly, let me know and I'll re-add you in a follow-up PR. Sorry if that happened! Co-authored-by: Sascha Mann <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Refers to #161.
Update
config/exercise_readme.go.tmplto add in the missing newline in the generated README before## Source, and remove the extra newline after that block. The new template ensure that the generated README have consistent single newline in the event of missing.Hints,.TrackInsert, and/or.Spec.Credits.Most READMEs will manually cater for it after generation, but that will make
bin/configlet generate .be non-idempotent.Also update READMEs that didn't cater for the missing/additional newline.