diff --git a/.changeset/silent-rivers-eat.md b/.changeset/silent-rivers-eat.md new file mode 100644 index 000000000..da5c60038 --- /dev/null +++ b/.changeset/silent-rivers-eat.md @@ -0,0 +1,5 @@ +--- +"@openproject/octicons": minor +--- + +Update `thumbsup` and `thumbsdown` icons diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9f8431ea8..f5ed6f607 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,9 @@ Thank you for your interest in contributing to Octicons! If you'd like to submit Follow these steps to add or update an icon. -### 1. Clone the repository +### Manually with SVG files + +#### 1. Clone the repository ```shell # Clone the repository @@ -29,13 +31,13 @@ cd openproject-octicons git remote add upstream https://github.com/opf/openproject-octicons ``` -### 2. Create a new feature branch +#### 2. Create a new feature branch ```shell git checkout -b ``` -### 3. Add or update SVG files in the `/icons` directory +#### 3. Add or update SVG files in the `/icons` directory Be sure to add SVG files with the correct naming (suffix `-16` required, suffixes `-12` and `-24` are optional). Check for the correct viewBox @@ -82,6 +84,46 @@ the icon will be used and any relevant timeline information. If everything looks good, a maintainer will approve and merge the pull request when appropriate. After the pull request is merged, your icon will be available in the next Octicons release. +### Using the Octicons Push Figma plugin + +If you work at GitHub, you can use the [Octicons Push](https://www.figma.com/community/plugin/825432045044458754/Octicons-Push) Figma plugin to start an Octicons pull request from Figma. + +Here's how it works: + +1. Select the icon frames you want to commit. Make sure the frames are either 16x16 or 24x24 and that you've outlined all strokes. +2. Open the Octicons Push plugin. +3. Select the branch you want to commit to. You can choose an existing branch or create a new branch. +4. Press "Commit." The plugin will then export, commit, and push the selected icons to the branch you chose. If you chose to create a new branch, the plugin will give you a link to where you can start a new pull request with your branch. + +After you create a pull request, a member of the Design Infrastructure team will triage and review your contribution. + +![demo showing how to create a pull request using the Octicons Push Figma plugin](https://user-images.githubusercontent.com/4608155/77948730-b1a24600-727a-11ea-9c39-040be9a12963.gif) + +## How changes are reviewed + +Here are a few questions we'll ask when reviewing new octicons. Keep these in mind as you're designing: + +- Where will this icon be used in the context of GitHub UI? +- Is an icon necessary in that context? +- Could we use an existing icon? +- Is the icon trying to represent too many ideas? +- Does it follow the design guidelines? + +## Releasing changes + +Once submitted changes have been agreed upon, these instructions will guide maintainers through releasing changes. + +Releases are managed by 🦋 [Changesets](https://github.com/atlassian/changesets#documentation) which is a great tool for managing major/minor/patch bumps and changelogs. More info can be found in our [how we work docs](https://github.com/github/design-infrastructure/blob/main/how-we-work/engineering/changesets.md#using-changesets-to-prepare-and-publish-a-release). + +We have the [changeset-bot comment on new pull requests](https://github.com/changesets/bot#readme) asking contributors or maintainers to add a changeset file, which will become the markdown supported changelog entry for the change. + +When creating the changeset always commit into the working branch (pull request branch), not `main`. + +When a pull request is approved merge it into the `main` branch. The changeset action will then create a Release pull request that includes this new pull request. + +Once maintainers have agreed and are satisfied with the release. Merge the Release pull request. Changesets will then publish a new GitHub release to the repository with the changelog and new version number. A second action will be triggered by this release and publish the new versions to npm and rubygems. + +🎉 Congratulations! The new release has been published. ## Other contributions diff --git a/icons/thumbsdown-16.svg b/icons/thumbsdown-16.svg index f400783e4..be54cb71b 100644 --- a/icons/thumbsdown-16.svg +++ b/icons/thumbsdown-16.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/icons/thumbsdown-24.svg b/icons/thumbsdown-24.svg index 2d0526e4b..2c290998d 100644 --- a/icons/thumbsdown-24.svg +++ b/icons/thumbsdown-24.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/icons/thumbsup-16.svg b/icons/thumbsup-16.svg index 59d61e67d..3e837d1c1 100644 --- a/icons/thumbsup-16.svg +++ b/icons/thumbsup-16.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/icons/thumbsup-24.svg b/icons/thumbsup-24.svg index f16dda83b..0e50c53df 100644 --- a/icons/thumbsup-24.svg +++ b/icons/thumbsup-24.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file