feat: add some comments

fs.go

@@ -85,7 +85,7 @@ func CopyFile(fs afero.Fs, sourcePath, targetPath string) error {
  return nil
 }
 
-// CopyFileFsToFs will copy the given sourcePath to the targetPath inside the passed afero.Fs.
+// CopyFileFsToFs will a file from the given sourceFs and sourcePath to the targetFs and targetPath
 func CopyFileFsToFs(sourceFs afero.Fs, targetFs afero.Fs, sourcePath, targetPath string) error {
  sourceExists, err := afero.Exists(sourceFs, sourcePath)
  if err != nil {

skipper.go

@@ -79,6 +79,7 @@ func LoadSkipperConfig(file *YamlFile, rootKey string) (*SkipperConfig, error) {
  return nil, fmt.Errorf("failed to unmarshal SkipperConfig: %w", err)
  }
 
+ // ensure ignore regex can be compiled
  for _, regex := range config.IgnoreRegex {
  _, err := regexp.Compile(regex)
  if err != nil {

template.go

@@ -132,7 +132,11 @@ func (t *Templater) Execute(template *File, data any, allowNoValue bool, renameC
  return t.execute(template, data, template.Path, allowNoValue)
 }
 
+// execute is the main rendering function for templates
 func (t *Templater) execute(tplFile *File, data any, targetPath string, allowNoValue bool) error {
+
+ // if the template matches any IgnoreRegex, just copy the file to the targetPath
+ // without rendering it as template
  for _, v := range t.IgnoreRegex {
  if v.MatchString(tplFile.Path) {
  err := CopyFileFsToFs(t.templateFs, t.outputFs, tplFile.Path, targetPath)
@@ -142,6 +146,7 @@ func (t *Templater) execute(tplFile *File, data any, targetPath string, allowNoV
  return nil
  }
  }
+
  err := tplFile.Load(t.templateFs)
  if err != nil {
  return err