Skip to content

Commit

Permalink
Merge branch 'master' into app-edu
Browse files Browse the repository at this point in the history
  • Loading branch information
palob authored Oct 28, 2024
2 parents 83afee5 + e878f9d commit 114af2a
Show file tree
Hide file tree
Showing 8,427 changed files with 116,399 additions and 89,660 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
10 changes: 6 additions & 4 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
root = true

[*]
[*.{json,md,py,svg,yml}]
end_of_line = lf
charset = utf-8
indent_size = 2
indent_style = space
trim_trailing_whitespace = true
insert_final_newline = true

[*.json]
insert_final_newline = false
[*.{md,yml}]
indent_size = 2

[*.svg]
indent_size = 1

[*.{py,json}]
indent_size = 4
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# https://help.github.com/articles/about-codeowners

# General Owners
* @Foggalong
* @Foggalong @palob

# Icon Owners
/icons/ @Foggalong @palob
Expand Down
16 changes: 8 additions & 8 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ include:
Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
professional setting

## Our Responsibilities

Expand Down Expand Up @@ -67,10 +67,10 @@ members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
[version 1.4]. For answers to common questions about this code of conduct, see
the [FAQ].

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
[version1.4]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[faq]: https://www.contributor-covenant.org/faq
52 changes: 32 additions & 20 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,34 @@
# Contributing to Numix Core

So you want to contribute to the Numix app themes? Great! Make sure that you're doing the following so that we can get your contributions merged in as soon as possible.

## General Process

All contributions, regardless of which bit of the project they're part of, must follow these steps:

1. [Fork](https://help.github.com/articles/fork-a-repo/) our GitHub repository
2. Make your changes and [push them](https://help.github.com/articles/pushing-to-a-remote/) to your fork
1. Remember to write a proper [commit message](https://chris.beams.io/posts/git-commit/)
2. If you're fixing an issue, [close it using keywords](https://help.github.com/articles/closing-issues-via-commit-messages/)
1. Remember to write a proper [commit message](https://chris.beams.io/posts/git-commit/)
2. If you're fixing an issue, [close it using keywords](https://help.github.com/articles/closing-issues-via-commit-messages/)
3. Create a new [pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/)
4. Make any changes requested and push again
4. When the pull request is accepted you can delete your fork or [sync it](https://help.github.com/articles/syncing-a-fork/)
5. When the pull request is accepted you can delete your fork or [sync it](https://help.github.com/articles/syncing-a-fork/)

Now you are ready to start again!


## Icons

This section covers what to do when creating a new icon or changing the design for an existing icon. If you're wanting to add a symlink see the section on the data file.

1. Make your icon using [Inkscape](https://inkscape.org/) (free and open source)
1. You must follow our [style guidelines](https://github.com/numixproject/numix-core/wiki/Guidelines)
2. Icons must be saved as an optimised SVG with [these settings](https://github.com/numixproject/numix-core/wiki/Optimise-Options)
3. New icon need an entry in the [data file](https://github.com/numixproject/numix-core/blob/master/.github/CONTRIBUTING.md#data-file)
1. You must follow our [style guidelines](https://github.com/numixproject/numix-core/wiki/Guidelines)
2. Icons must be saved as an optimized SVG with [these settings](https://github.com/numixproject/numix-core/wiki/Optimise-Options)
3. New icon need an entry in the [data file](https://github.com/numixproject/numix-core/blob/master/.github/CONTRIBUTING.md#data-file)
2. Create a different pull request for each (unrelated) change you're submitting
1. Pull requests must contain icons for Circle and Square at minimum
2. Adding icons for other themes such as Shine and uTouch is optional
1. Pull requests must contain icons for Circle and Square at minimum
2. Adding icons for other themes such as Shine and uTouch is optional
3. Include a sample of your icon ([example](https://github.com/numixproject/numix-core/pull/1422)) to make review easier


## Data File

The `data.json` file contains all the information needed for linking the icons to the names needed by different platforms. It has the following structure:
Expand All @@ -44,23 +45,34 @@ The `data.json` file contains all the information needed for linking the icons t
"alternative-entry",
"org.other.Entry"
]
}
},
"osx": [
"icon-name",
"alternative-name"
],
"tags": ["tag1", "tag2", "tag3"]
}
}
```

* The `icon-entry` is the name of the SVG file and should be [meaningfully named](https://github.com/numixproject/numix-core/blob/master/data.json#L7529-L7533) using [dash-case](https://en.wikipedia.org/wiki/Naming_convention_(programming)#Delimiter-separated_words).
* The `android` part is the list of components the icon should use, which can be gathered from the "ComponentInfo" [here](http://activities.tundem.com/).
* The `linux` part holds the names from the `Icon=*` line of `*.desktop` files
* the `root` holds the primary entry
* the `symlinks` holds alternative names
If you're making changes to this file in a pull request Travis will run a validation check to make sure you haven't made any errors, but please try and check before pushing to make review as easy as possible.
* `icon-entry` is the name of the SVG file and should be [meaningfully named](https://github.com/numixproject/numix-core/blob/master/data.json#L10-L17) using [dash-case](https://en.wikipedia.org/wiki/Naming_convention_(programming)#Delimiter-separated_words).
* `android` is a list of components the icon should use, which can be gathered from the "ComponentInfo" [here](http://activities.tundem.com/).
* `linux` holds the names from the `Icon=*` line of `*.desktop` files
* `root` holds the primary entry
* `symlinks` holds alternative names
* `osx` is a list of icon names to export for the macOS theme.
* `tags` is a list of [common design elements](../Icons) used by this SVG.

When editing this file for a pull request GitHub Actions will run a validation check to make sure you haven't made any errors, but please try and check before pushing to make review as easy as possible.

## Code
The scripts used for theme building and validation are written in Python. Similarly to the data file, Travis will run a validation check using [pycodestyle](https://github.com/pycqa/pycodestyle) to make sure the coding style you've used is consistent with that used in the project. If you are working on this part of the project it's recommended that you check your changes using a pycodestyle linter before creating a pull request.

The scripts used for theme building and validation are written in Python. Similarly to the data file, GitHub Actions will run a validation check using [flake8](https://flake8.pycqa.org) to make sure the coding style you've used is consistent with that used in the project. If you are working on this part of the project it's recommended that you check your changes using flake8 before creating a pull request.

### Indentation
Throughout this project we use 4 spaces for JSON and Python files, and generally use 1 space for SVG. If you want to diverge, do it locally (e.g. using [git filters](https://stackoverflow.com/questions/2316677/can-git-automatically-switch-between-spaces-and-tabs#2318063)).

Throughout this project we use 4 spaces for JSON and Python files, and generally use 1 space for SVG. The easiest way to do this is to use the [editorconfig](https://editorconfig.org) included [here](../.editorconfig). If you want to diverge, do it locally (e.g. using [git filters](https://stackoverflow.com/questions/2316677/can-git-automatically-switch-between-spaces-and-tabs#2318063)).

## Docs

Documentation is all written in markdown and should be [markdownlint](https://github.com/DavidAnson/markdownlint) compliant.
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-core.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: 🐛 Core Bug Report
about: Report an issue with the Core scripts and documentation
title: ''
labels: [bug, script]
assignees: ''

---

<!--
This bug report is just for issues with Core (that's the Python code and its documentation)
Please file issues with packaging in the theme's respective repo:
- numix-icon-theme (base): https://github.com/numixproject/numix-icon-theme
- numix-icon-theme-circle: https://github.com/numixproject/numix-icon-theme-circle
- numix-icon-theme-square: https://github.com/numixproject/numix-icon-theme-square
For issues with icons please use the relevant issue template.
-->

## Info
<!-- Give the operating system / Linux distro on which you're experiencing the problem. -->
Platform: SYSTEM v0.0
<!-- If the bug relates to some specific external software, specify it and its version here -->
Related software Version: SOFTWARE v0.0

## Problem
<!-- Give a brief description of the problem you're having. -->
PROBLEM_HERE

## To Reproduce
<!-- If applicable, let us know what steps we should take to reproduce the error. -->
1. Do this,
2. Then that,
3. ???
4. Bug

## Screenshots
<!-- If applicable attach any screenshots demonstrating the problem. -->
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-icons.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
name: 🐛 Icon Bug Report
about: Report an issue with an icon
title: ''
labels: bug
assignees: ''

---

<!--
This bug report is just for issues with the icon files (e.g. we've accidentally pushed an
invalid SVG file like we did here: https//github.com/numixproject/numix-icon-theme/issues/1405).
For icon requests and enhancements please use their respective issue templates.
Please file issues with packaging in the theme's respective repo:
- numix-icon-theme (base): https://github.com/numixproject/numix-icon-theme
- numix-icon-theme-circle: https://github.com/numixproject/numix-icon-theme-circle
- numix-icon-theme-square: https://github.com/numixproject/numix-icon-theme-square
For issues with core use the Core Bug Report issue template.
-->

## Info
<!-- Give the operating system / Linux distro on which you're experiencing the problem. -->
Platform: SYSTEM v0.0
<!-- If the bug relates to some specific external software, specify it and its version here -->
Related Software: SOFTWARE v0.0

## Affected Icons
<!-- List the icons which are affected by this bug. -->
- [ ] ICON_1
- [ ] ICON_2
- [ ] ICON_3

## Problem
<!-- Give a brief description of the problem you're having. -->
PROBLEM_HERE

## To Reproduce
<!-- If applicable, let us know what steps we should take to reproduce the error. -->

1. DO THIS
2. THEN THAT
3. ???
4. BUG

## Screenshots
<!-- If applicable attach any screenshots demonstrating the problem. -->
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: ✨ Improve an existing icon
about: Request a change to an existing icon
title: ''
labels: enhancement
assignees: ''

---

<!-- Give the name of the icon you'd like improving https://github.com/numixproject/numix-core/find/master -->
Icon name: `APP_ICON_NAME`

<!-- Give a brief explanation of why this icon needs changing. -->
Explanation: `APP_DESCRIPTION`

<!-- Upload a screenshot or copy of the original icon the app used in its launcher. -->
Original icon:

![original](https://cloud.githubusercontent.com/assets/5920259/25233502/e8d0afd4-25d6-11e7-9182-b4102e40ae5a.png)
16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE/linux-icon-reqest.md

This file was deleted.

21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/request-chrome.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: 🖌️ Chrome App Icon Request
about: Request a missing icon for a Chrome webapp
title: ''
labels: linux
assignees: ''

---
<!-- Give the name of the app you would like an icon for. -->
App name: `APPLICATION_NAME`

<!-- Please provide a link to the app on the https://chrome.google.com/webstore -->
Icon name: `APP_ICON_NAME`

<!-- Upload a screenshot or copy of the original icon the app used in its launcher. -->
Original icon:

![original](https://cloud.githubusercontent.com/assets/5920259/25233502/e8d0afd4-25d6-11e7-9182-b4102e40ae5a.png)

<!-- Give a brief description of the app and what it does. -->
Description: `APP_DESCRIPTION`
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/request-linux.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: 🖌️ Linux Icon Request
about: Request a missing icon for a standard Linux app
title: ''
labels: linux
assignees: ''

---
<!-- Give the name of the app you would like an icon for and a link to its official website or source code. -->
App name: `APPLICATION_NAME`, `APP_WEBSITE`

<!-- We need the icon name given in the app's .desktop launcher, shown in the line beginning `Icon=` -->
Icon name: `APP_ICON_NAME`

<!-- In some cases we also need to know the filename of the launcher -->
Desktop filename: `APP_LAUNCHER.desktop`

<!-- Upload a screenshot or copy of the original icon the app used in its launcher. -->
Original icon:

![original](https://cloud.githubusercontent.com/assets/5920259/25233502/e8d0afd4-25d6-11e7-9182-b4102e40ae5a.png)

<!-- Give a brief description of the app and what it does. -->
Description: `APP_DESCRIPTION`
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/request-steam.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: 🖌️ Steam Game Icon Request
about: Request a missing icon for a Steam Game
title: ''
labels: linux
assignees: ''

---
<!-- Give the name of the game you would like an icon for. -->
Game name: `GAME_NAME`

<!-- For Steam games we need the app ID that Steam uses to identify the game. Luckily these are easy to find, you can just search SteamDB and it's the very first entry on each page (for example, Team Fortress 2 is https://steamdb.info/app/440). If this game comes with DLC, demos, alternative version, etc which have distinct app IDs please list them here also since they'll have distinct launchers (e.g. 3900 & 3990 are both Civilization IV). -->
AppID: `STEAM_ID`

<!-- Upload a screenshot or copy of the original icon the game used in its launcher. -->
Original icon:

![original](https://cloud.githubusercontent.com/assets/5920259/25233502/e8d0afd4-25d6-11e7-9182-b4102e40ae5a.png)

<!-- Give a brief description of the game. -->
Description: `GAME_DESCRIPTION`
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/request-windows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: 🖌️ Windows Icon Request
about: Request an icon for a Windows app run through WINE, etc
title: ''
labels: [hardcoded, wontfix]
assignees: ''

---

<!-- IMPORTANT: we don't usually fulfill requests for Windows apps unless it's an obviously popular piece of software (e.g. Microsoft Word) or there's significant support behind the issue (usually 5+ people giving it a :+1:). That's partly because all apps run through WINE, Crossover, etc have hardcoded icons and partly because there are enough Linux, Android, and macOS apps to worry about without also worrying about Windows too. -->

<!-- Give the name of the app you would like an icon for and a link to its official website or source code. -->
App name: `APPLICATION_NAME`, `APP_WEBSITE`

<!-- Upload a screenshot or copy of the original icon the app used in its launcher. -->
Original icon:

![original](https://cloud.githubusercontent.com/assets/5920259/25233502/e8d0afd4-25d6-11e7-9182-b4102e40ae5a.png)

<!-- Give a brief description of the app and what it does. -->
Description: `APP_DESCRIPTION`
4 changes: 4 additions & 0 deletions .github/workflows/markdownlint-config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"default": true,
"line-length": false
}
Loading

0 comments on commit 114af2a

Please sign in to comment.