diff --git a/.github/workflows/build_icons.yml b/.github/workflows/build_icons.yml index f4ebb5297..82016449e 100644 --- a/.github/workflows/build_icons.yml +++ b/.github/workflows/build_icons.yml @@ -65,8 +65,7 @@ jobs: Adios, Build Bot :sunglasses: with: - branch: 'master-build-result' - base: 'master' + branch: 'bot/build-result' commit-message: 'Built new icons, icomoon.json and devicon.css' title: 'bot:build new icons, icomoon.json and devicon.css' body: ${{ format(env.MESSAGE, fromJSON(steps.imgur_step.outputs.imgur_urls)[0] ) }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e3afaf9e9..b86006dd9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,7 @@ First of all, thanks for taking the time to contribute! This project can only gr
Here are some terms that we will use in this repo:
svg
" refers to the svg
versions of the Icons.We are running a Discord server. You can go here to talk, discuss, and more with the maintainers and other people, too. Here's the invitation: https://discord.gg/hScy8KWACQ. If you don't have a GitHub account but want to suggest ideas or new icons, you can do that here in our Discord channel. -Note that the Discord server is unofficial, and Devicons is still being maintained via GitHub. +Note that the Discord server is unofficial, and Devicons is still being maintained via GitHub.
+ +Devicon does not follow a strict release plan. A new release is depended on current amount of contributions, required bugfixes/patches and will be discussed by the team of maintainers.
+Generally speaking: A new release will be published when new icons are added or a bug was fixed. When it's predictable that multiple icons are added in a foreseeable amount of time they are usually wrapped together.
+The version naming follows the rules of Semantic Versioning. Given a version number MAJOR.MINOR.PATCH, increment the:
+development
as draft-release
branchnpm version vMAJOR.MINOR.PATCH -m "bump npm version to vMAJOR.MINOR.PATCH"
(see #487
)draft-release
build_icons.yml
(which has a workflow_dispatch
event trigger) and select the branch draft-release
as target branch. This will build a font version of all icons using icomoon and automatically creates a pull request to merge the build result back into draft-release
development
. Mention the release number in the pull request title and add information about all new icons, fixes, features and enhancements in the description of the pull request. Take the commits as a guideline. It's also a good idea to mention and thank all contributions who participated in the release (take description of #504
as an example).master
and HEAD development
. Copy the description of the earlier pull request.npm publish
leading to a updated npm package (vMAJOR.MINOR.PATCH).