Conversation
Also delete a stray, unused file and add `.editorconfig`
There was a problem hiding this comment.
Pull request overview
This pull request adds a profile README for the Scratch organization on GitHub and implements comprehensive markdown formatting improvements across community health files. The changes align with markdownlint standards and improve the welcome experience for new contributors by providing clear, well-formatted documentation.
Changes:
- Added organization profile README with Scratch mission, open source commitment, and contribution information
- Implemented consistent markdown formatting across all documentation files with 118-character line length limit
- Added .editorconfig to enforce consistent formatting standards across the repository
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| profile/README.md | New organization profile README introducing Scratch and guiding contributors |
| README.md | Added blank line for proper markdown formatting |
| PULL_REQUEST_TEMPLATE.md | Reformatted with YAML frontmatter and consistent line wrapping |
| ISSUE_TEMPLATE/BUG_REPORT.md | Removed duplicate issue template (consolidated into .github/ISSUE_TEMPLATE/) |
| CONTRIBUTING.md | Reformatted with improved readability and consistent markdown styling |
| .github/ISSUE_TEMPLATE/bug_report.md | Improved formatting and clarified instructions |
| .editorconfig | New file establishing editor configuration standards (UTF-8, LF, 118 char max) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -35,54 +50,77 @@ Public repositories where we encourage contributions have a repository coordinat | |||
| * scratchjr-website @chrisgarrity | |||
|
|
|||
| Repositories that do not accept external PRs: | |||
|
|
|||
| * scratch-l10n | |||
| * scratch-paint | |||
| * scratch-parser | |||
| * scratch-render-fonts | |||
| * scratch-resources | |||
| * scratch-sb1converter | |||
|
|
|||
| ### Learning Git and Github | |||
| ## Learning Git and Github | |||
|
|
|||
| If you want to work on fixing issues, you should be familiar with Git and Github. | |||
|
|
|||
| * [Learn Git branching](https://learngitbranching.js.org/) includes an introduction to basic git commands and useful branching features. | |||
| * Here's a general introduction to [contributing to an open source project](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github). | |||
| * [Learn Git branching](https://learngitbranching.js.org/) includes an introduction to basic git commands and useful | |||
| branching features. | |||
| * Here's a general introduction to [contributing to an open source project]( | |||
| https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github). | |||
|
|
|||
| **Important:** we follow the [Github Flow process](https://guides.github.com/introduction/flow/) as our development | |||
| process. | |||
|
|
|||
| **Important:** we follow the [Github Flow process](https://guides.github.com/introduction/flow/) as our development process. | |||
| ## How to Fix Bugs | |||
|
|
|||
| ### How to Fix Bugs | |||
| 1. Identify which Github issue you are working on. Leave a comment on the issue to let us (and other contributors) know you're working on it. | |||
| 2. Make sure you have a fork of this repo (see [Github's forking a repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) for details) | |||
| 1. Identify which Github issue you are working on. Leave a comment on the issue to let us (and other contributors) | |||
| know you're working on it. | |||
| 2. Make sure you have a fork of this repo (see [Github's forking a repo]( | |||
There was a problem hiding this comment.
The word "Github" should be capitalized as "GitHub" according to GitHub's official branding guidelines. This appears multiple times in this file including in section headers and body text.
| indent_style = space | ||
| insert_final_newline = true | ||
| max_line_length = 118 | ||
| rulers = 80, 118 |
There was a problem hiding this comment.
The property "rulers" is not part of the official EditorConfig specification. While some editors like VS Code may recognize this property, it will be ignored by most EditorConfig-compliant editors. Consider removing this property or documenting it as editor-specific configuration that should be placed in editor-specific settings files instead.
| rulers = 80, 118 |
| issue, or that only partially implement a fix._ | ||
|
|
||
| ### Proposed Changes | ||
| - Resolves #0 |
There was a problem hiding this comment.
The placeholder value "Resolves #0" is problematic because GitHub will create a link to a non-existent issue #0. Consider changing this to "Resolves #" or "Resolves #ISSUE_NUMBER" to make it clearer that this is a placeholder that needs to be replaced.
| - Resolves #0 | |
| - Resolves #ISSUE_NUMBER |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 participant
Proposed Changes
Add a profile
README.mdfor our organization, plusmarkdownlintand other cleanup.Reason for Changes
Hopefully, this will provide a better welcome for new contributors.