Improve README clarity and consistency#3088
Merged
Conversation
- Fix lesson front matter example to use correct Elixir map format - Add missing excerpt field to lesson metadata documentation - Add style guide link to contribution guidelines - Link to version report section to reduce duplication - Fix typo: confirm → conform
There was a problem hiding this comment.
Pull request overview
Updates the repository’s main README to better guide contributors/translators by aligning documentation with the actual lesson/blog metadata format and existing contribution guidance.
Changes:
- Adds a prominent style guide link alongside the Contributing link.
- Updates translation instructions to reference the “Translation Version Report” section and documents the
excerptmetadata requirement. - Replaces the lesson front matter example from YAML to the correct Elixir map format and fixes a typo (“confirm” → “conform”).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| version: "1.0.0", | ||
| title: "基本", | ||
| excerpt: """ | ||
| 基本についての短い説明。 |
This file contains hidden or 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
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.
Aligns the README with CONTRIBUTING.md and improves contributor experience.
Changes:
excerptfield to lesson metadata documentationThese updates ensure new contributors see the correct metadata format and are aware of the style guide before submitting changes.