Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
…material-icon-theme into fix/histoire-pixel-perfect-design
  • Loading branch information
PKief committed Nov 6, 2024
2 parents 456f9e8 + 9a20aa9 commit e75be81
Show file tree
Hide file tree
Showing 886 changed files with 1,442 additions and 991 deletions.
31 changes: 22 additions & 9 deletions .github/copilot-instructions.md
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.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@

## Contribution Guidelines

- [ ] By creating this pull request, I acknowledge that I have read the [Contribution Guidelines](https://github.com/material-extensions/vscode-material-icon-theme/blob/main/CONTRIBUTING.md) for this project.
- [ ] By creating this pull request, I acknowledge that I have read the [Contribution Guidelines](https://github.com/material-extensions/vscode-material-icon-theme/blob/main/CONTRIBUTING.md) for this project
- [ ] I have read the [Code Of Conduct](https://github.com/material-extensions/vscode-material-icon-theme/blob/main/CODE_OF_CONDUCT.md) and promise to abide by these rules
27 changes: 27 additions & 0 deletions .github/workflows/pr-title.yml
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
42 changes: 42 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,48 @@
All notable changes to this project will be documented in this file. Dates are displayed in UTC.


#### [v5.13.0](https://github.com/material-extensions/vscode-material-icon-theme/compare/v5.12.0...v5.13.0)

> November 5, 2024
- chore: Ignore dependency update for @types/vscode in renovate [`0ecabdde`](https://github.com/material-extensions/vscode-material-icon-theme/commit/0ecabdde)
- chore: Use type of supported VS Code engine only [`f59fc994`](https://github.com/material-extensions/vscode-material-icon-theme/commit/f59fc994)
- feat(docs): :memo: improve copilot instructions [`#2669`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2669)
- feat: 🏞️ add additional file extensions for raw images and xml [`#2673`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2673)
- feat: add `installation` icon [`#1760`](https://github.com/material-extensions/vscode-material-icon-theme/pull/1760)
- feat: add `histoire config` icon [`#1626`](https://github.com/material-extensions/vscode-material-icon-theme/pull/1626)
- chore(icons)!: update `kotlin` icon colors to latest version [`#2666`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2666)
- feat: Add Luau and Roblox ecosystem icons [`#1560`](https://github.com/material-extensions/vscode-material-icon-theme/pull/1560)
- feat: ✨ `.editorconfig-checker.json` and `.ecrc` file icon [`#2665`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2665)
- chore(deps): update dependency bun to v1.1.34 [`#2663`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2663)
- feat: add `dependencies-update` icon [`#1505`](https://github.com/material-extensions/vscode-material-icon-theme/pull/1505)
- chore(deps): update bun to v1.1.33 [`#2656`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2656)
- chore(deps): update bun packages (major) [`#2660`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2660)
- chore(deps): update bun packages [`#2659`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2659)
- chore(deps): update softprops/action-gh-release action to v2.0.9 [`#2657`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2657)
- feat: :sparkles: replace dependabot with renovate [`#2652`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2652)
- fix(workflows): :bug: fix failing `icon-review` workflow [`#2651`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2651)
- fix: materialized `swc` icon [`#1975`](https://github.com/material-extensions/vscode-material-icon-theme/pull/1975)
- feat: :sparkles: add icon for `.bun-version` file [`#2649`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2649)
- fix(workflows): rollback Bun version (`1.1.33``1.1.28`) [`#2648`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2648)
- feat(workflows): add emojis to the names of workflows [`#2645`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2645)
- feat(workflows): use Bun version from `.bun-version` file [`#2644`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2644)
- chore(docs): add useful comments and update issue templates [`#2643`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2643)
- feat: trigger [`#2570`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2570)
- feat: add Copilot instructions [`#2640`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2640)
- docs: :fire: Remove Phorm.ai badge [`#2641`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2641)
- fix: 🚑 fix `swc` icon colors [`#2638`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2638)
- feat: add `.swcrc` icon for SWC and rename `swc` to `adobe-swc` [`#2232`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2232)
- feat: add `controller` icon [`#1634`](https://github.com/material-extensions/vscode-material-icon-theme/pull/1634)
- feat: add `pre-commit` configuration icon [`#1643`](https://github.com/material-extensions/vscode-material-icon-theme/pull/1643)
- feat: add benchmark icon for [`#2206`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2206)
- feat: icon for all the cloud channels [`#1320`](https://github.com/material-extensions/vscode-material-icon-theme/pull/1320)
- feat: use Perl's own logo instead copying Tor's [`#876`](https://github.com/material-extensions/vscode-material-icon-theme/pull/876)
- feat: add garden file icon [`#2176`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2176)
- build(deps): bump `actions/checkout` from `4.2.1` to `4.2.2` [`#2635`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2635)
- feat: add `node` and `nodejs` to folderIcons.ts [`#2636`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2636)
- ci: update pixp url in icon-review.yml [`#2633`](https://github.com/material-extensions/vscode-material-icon-theme/pull/2633)

#### [v5.12.0](https://github.com/material-extensions/vscode-material-icon-theme/compare/v5.11.1...v5.12.0)

> October 23, 2024
Expand Down
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Glad you're here and interested in expanding this project 🎉 In order to make

- [Icon Requests](#icon-requests)
- [Add new icons](#add-new-icons)
- [Conventional Pull Request Titles](#conventional-pull-request-titles)
- [How-To's](#how-tos)
- [Create icon as SVG](#create-icon-as-svg)
- [Use Material Design colors](#material-design-colors)
Expand Down Expand Up @@ -45,6 +46,18 @@ flowchart LR
E[<a href="#creating-new-icons-workflow">Creating New Icons Workflow</a>]
```

## Conventional Pull Request Titles

The title of your pull request should follow the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/). When a pull request is merged to the main branch, all changes are going to be squashed into a single commit. The message of this commit will be the title of the pull request. And for every release, the commit messages are used to generate the changelog.

Here are some examples of conventional PR titles:

- `feat: add new icons for Rust`
- `fix: correct icon for .gitignore`
- `ci: add GitHub Actions for automated testing`

Generating the changelog based on the commit messages saves time and helps to keep the changelog up-to-date. It also helps to understand the changes in the project.

### Creating New Icons Workflow

#### Checklist
Expand Down
Binary file modified bun.lockb
Binary file not shown.
15 changes: 15 additions & 0 deletions commitlint.config.js
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;
2 changes: 1 addition & 1 deletion icons/3d.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion icons/abc.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion icons/actionscript.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion icons/ada.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion icons/adobe-swc.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion icons/android.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion icons/antlr.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit e75be81

Please sign in to comment.