Skip to content

Format all instructions.append.md to start with an H1 (required but ignored) and H2#1633

Open
IsaacG wants to merge 1 commit into
exercism:mainfrom
IsaacG:append.headers
Open

Format all instructions.append.md to start with an H1 (required but ignored) and H2#1633
IsaacG wants to merge 1 commit into
exercism:mainfrom
IsaacG:append.headers

Conversation

@IsaacG
Copy link
Copy Markdown
Member

@IsaacG IsaacG commented May 25, 2026

See related discussions here as well as exercism/docs#592. Append files should all have an H1. Including an H2 helps break the flow from the non-append file to the append file so it does not read as the same stream of thought.

@github-actions
Copy link
Copy Markdown
Contributor

Thank you for contributing to exercism/elixir 💜 🎉. This is an automated PR comment 🤖 for the maintainers of this repository that helps with the PR review process. You can safely ignore it and wait for a maintainer to review your changes.

Based on the files changed in this PR, it would be good to pay attention to the following details when reviewing the PR:

  • General steps

    • 🏆 Does this PR need to receive a label with a reputation modifier (x:size/{tiny,small,medium,large,massive})? (A medium reputation amount is awarded by default, see docs)
  • Any exercise changed

    • 👤 Does the author of the PR need to be added as an author or contributor in <exercise>/.meta/config.json (see docs)?
    • 🔬 Do the analyzer and the analyzer comments exist for this exercise? Do they need to be changed?
    • 📜 Does the design file (<exercise>/.meta/design.md) need to be updated to document new implementation decisions?
  • Practice exercise changed

    • 🌲 Do prerequisites, practices, and difficulty in config.json need to be updated?
    • 🧑‍🏫 Are the changes in accordance with the community-wide problem specifiations?

Automated comment created by PR Commenter 🤖.

@angelikatyborska
Copy link
Copy Markdown
Member

I am assuming this is some sort of global platform change. Could you please provide a link to an explanation where this change is discussed and/or announced so I could familiarize myself? PRs with empty descriptions are confusing to maintainers that don't read whichever communications channel this was announced in.

@IsaacG
Copy link
Copy Markdown
Member Author

IsaacG commented May 26, 2026

Apologies. See related discussions here as well as exercism/docs#592

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.

2 participants