Update CONTRIBUTING.md

This commit is contained in:
Adrian Środoń 2022-11-06 13:56:33 +01:00 committed by GitHub
parent b11e7a8000
commit 1fd9e36aa2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,14 +1,13 @@
# Contributing guide # Contributing guide
Thank you for investing your time in contributing to our project! :sparkles:. Thank you for investing your time in contributing to this project! :sparkles:.
## New contributor guide ## New contributor guide
To get an overview of the project, read the [README](README.md). To get an overview of the project, read the [README](README.md) and [wiki page](https://github.com/AdisonCavani/distro-grub-themes/wiki).
## Getting started ### Project structure:
Project structure:
``` ```
. .
├── assets - assets for creating background images ├── assets - assets for creating background images
@ -20,3 +19,14 @@ Project structure:
├── preview - preview images for README.md ├── preview - preview images for README.md
└── themes - compressed themes ready to install in .tar format └── themes - compressed themes ready to install in .tar format
``` ```
### 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](https://github.com/AdisonCavani/distro-grub-themes/blob/master/.github/workflows/update-content.yml)).
You can track your workflows [here](https://github.com/AdisonCavani/distro-grub-themes/actions).