-
-
Notifications
You must be signed in to change notification settings - Fork 640
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/material-extensions/vscode-…
…material-icon-theme into fix/histoire-pixel-perfect-design
- Loading branch information
Showing
886 changed files
with
1,442 additions
and
991 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,22 @@ | ||
# General Principles | ||
|
||
1. **Follow the project style**: All changes should adhere to the existing code and documentation style. | ||
2. **Use Material Design colors**: All icons should use colors from the [Material Design color palette](/material-colors.yml). | ||
3. **Adhere to project architecture**: All changes should comply with the project architecture described in [architecture.md](/src/architecture.md). | ||
4. **Pixel-Perfect Icons**: Ensure that all icons are designed to be sharp and clear at 16x16 pixels, following the guidelines in [Designing Pixel Perfect Icons](/CONTRIBUTING.md#pixel-perfect-icons). | ||
5. **Write clean, modular, and well-documented code.**: All changes should be well-documented and easy to understand. | ||
6. **Test your changes**: All changes should be tested and should not break existing functionality. | ||
7. **Keep it simple**: All changes should be as simple as possible and should not introduce unnecessary complexity. | ||
# Copilot instructions | ||
|
||
To contribute effectively to this project, follow these guidelines: | ||
|
||
1. **Follow the project style**: Ensure all changes adhere to the existing code and documentation style. Review the [project's codebase](/) to understand the conventions used. | ||
2. **Use Material Design color palette**: When working with icons, use colors from the [Material Design color palette](/material-colors.yml). This ensures visual consistency across the project. | ||
3. **Adhere to the project architecture**: Familiarize yourself with the [project's architecture](/src/architecture.md). The core logic is separated from the extension logic. The core handles icon manifest generation, icon associations, and translation. The extension interacts with the VS Code API. Make sure to respect the dependency rules between modules. | ||
4. **Design pixel-perfect icons**: Create icons that are sharp and clear at 16x16 pixels. Align icons to a **16x16 grid** to ensure sharpness and avoid blurriness. More details are available in the [CONTRIBUTING.md](/CONTRIBUTING.md#pixel-perfect-icons). | ||
5. **Write clean, modular, and well-documented code**: Document your code thoroughly and ensure it is easy to understand and maintain. | ||
6. **Test your changes**: Always test your changes to ensure they do not break existing functionality. | ||
7. **Keep it simple**: Aim for simplicity in your solutions and avoid unnecessary complexity. | ||
8. **Add new icons appropriately**: | ||
|
||
- Use colors from the [Material Design color palette](https://material.io/design/color/the-color-system.html). | ||
- Ensure icons have proper spacing (Read [CONTRIBUTING.md](/CONTRIBUTING.md#icon-spacing)). | ||
- Assign icons uniquely to file names, extensions, or folder names according to the [project guidelines](/CONTRIBUTING.md). | ||
- Provide separate icons for different color themes if necessary (Read [CONTRIBUTING.md](/CONTRIBUTING.md#icons-for-color-themes)). | ||
|
||
9. **Clone existing icons when possible**: If you need a variant of an existing icon with a different color, clone the icon through configuration without creating a new SVG (Read [CONTRIBUTING.md](/CONTRIBUTING.md#icon-cloning)). | ||
10. **Contribute to translations**: If you notice errors in translations, you can help fix them by editing the appropriate translation files (`package.nls*.json`). | ||
|
||
Always ensure that your contributions comply with the project's guidelines and do not introduce any disallowed content. |
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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
name: ✅ Check PR Title | ||
|
||
on: | ||
pull_request: | ||
types: [opened, edited, synchronize] | ||
|
||
jobs: | ||
lint-pr-title: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: 🔧 Setup Bun | ||
uses: oven-sh/setup-bun@4bc047ad259df6fc24a6c9b0f9a0cb08cf17fbe5 # v2 | ||
with: | ||
bun-version-file: ".bun-version" | ||
|
||
- name: 📥 Checkout | ||
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
with: | ||
# Only fetch the config file from the repository | ||
sparse-checkout: commitlint.config.js | ||
|
||
- name: 📦 Install dependencies | ||
run: bun i @commitlint/config-conventional | ||
|
||
- name: 🔍 Check PR title with commitlint | ||
run: echo "${{ github.event.pull_request.title }}" | bunx commitlint --help-url https://github.com/material-extensions/vscode-material-icon-theme/blob/main/CONTRIBUTING.md#conventional-pull-request-titles |
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 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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
/** | ||
* @type {import('@commitlint/types').UserConfig} | ||
*/ | ||
const config = { | ||
extends: ['@commitlint/config-conventional'], | ||
rules: { | ||
'subject-case': [ | ||
0, | ||
'always', | ||
['sentence-case', 'start-case', 'pascal-case', 'upper-case'], | ||
], | ||
}, | ||
}; | ||
|
||
module.exports = config; |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.