Grub-Themes/CONTRIBUTING.md
2022-11-17 22:44:51 +01:00

1.5 KiB

Contributing guide

Thank you for investing your time in contributing to this project! .

New contributor guide

To get an overview of the project, read the README and wiki page.

Project structure:

.
├── assets                       - assets for creating background images
|   ├── background_template      - Photoshop project files for creating background images
|   ├── icons                    - icons that get copied to icons folder in every theme
|   └── preview_template         - Photoshop project files for creating preview images
├── customize                    - non-compressed themes
├── docs                         - documentation markdown files
├── fonts                        - fonts used in each theme
├── preview                      - preview images for README.md
├── themes                       - compressed themes ready to install in .tar format
└── themes.json                  - json file containing all themes definitions (used as database for wiki page)

Workflow

Folders that trigger new action/workflow:

  • assets/icons
  • customize
  • font

Every time you create new commit on master branch, github action bot will update all files (as defined in this file).
You can track your workflows here.