Error handling

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,39 @@
+---
+name: 🐞 Bug
+about: File a bug/issue
+title: '[BUG] <title>'
+labels: Bug, Needs Triage
+assignees: ''
+
+---
+
+<!--
+Note: Please search to see if an issue already exists for the bug you encountered.
+-->
+
+### Current Behavior:
+<!-- A concise description of what you're experiencing. -->
+
+### Expected Behavior:
+<!-- A concise description of what you expected to happen. -->
+
+### Steps To Reproduce:
+<!--
+Example: steps to reproduce the behavior:
+1. In this environment...
+1. With this config...
+1. Run '...'
+1. See error...
+-->
+
+### Minimal Example ical extract:
+
+```ical
+BEGIN:VCALENDAR
+....
+```
+
+### Anything else:
+<!--
+Links? References? Anything that will give us more context about the issue that you are encountering!
+-->

.github/ISSUE_TEMPLATE/other.md

@@ -0,0 +1,15 @@
+---
+name: Something else
+about: Any other issue
+title: '<title>'
+labels: Needs Triage
+assignees: ''
+
+---
+
+<!--
+Note: Please search to see if an issue already exists for the bug you encountered.
+
+Please include smallest possible sized examples.
+-->
+

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,35 @@
+<!-- 
+
+Thanks for contributing!
+
+-->
+
+# Pull Request Template
+
+## Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+<!-- The following line will automatically close the issues if done correctly -->
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- This might take a while to be considered
+
+## Must haves:
+
+- [ ] I have commented in hard-to-understand areas and anywhere the function not immediately apparent
+- [ ] I have made corresponding changes to the comments (if any)
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove the fix is effective or that my feature works
+- [ ] I have added tests that protects the code from degradation in the future
+
+## Nice to haves:
+
+- [ ] I have added additional function comments to new or existing functions

.github/workflows/golangci-lint.yml

@@ -9,21 +9,15 @@ on:
   pull_request:
 jobs:
   golangci:
-    name: lint
+    name: Lint
     runs-on: ubuntu-latest
+    permissions:
+      contents: read # allow read access to the content for analysis.
+      checks: write # allow write access to checks to allow the action to annotate code in the PR.
     steps:
-      - uses: actions/checkout@v2
-      - name: Cache-Go
-        uses: actions/cache@v1
-        with:
-          path: |
-            ~/go/pkg/mod              # Module download cache
-            ~/.cache/go-build         # Build cache (Linux)
-            ~/Library/Caches/go-build # Build cache (Mac)
-          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-          restore-keys: |
-            ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+      - name: Checkout
+        uses: actions/checkout@v4
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v2
+        uses: golangci/golangci-lint-action@v6
         with:
           version: latest

.github/workflows/goleaks.yml

@@ -0,0 +1,11 @@
+name: gitleaks
+on: [push,pull_request]
+jobs:
+  gitleaks:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: gitleaks-action
+      uses: zricethezav/gitleaks-action@master
+      env:
+         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/govun.yml

@@ -0,0 +1,11 @@
+name: Go vunderability check
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Setup Golang
+      uses: actions/setup-go@v5
+    - id: govulncheck
+      uses: golang/govulncheck-action@v1

.github/workflows/test.yml

@@ -1,28 +1,39 @@
 on: [push, pull_request]
 name: Test
 jobs:
-  test:
+  version:
+    name: Test
+    permissions:
+      contents: read
     strategy:
       matrix:
-        go-version: [1.14.x, 1.15.x, 1.16.x, 1.17.x]
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        go-version: ['oldstable', 'stable']
+        os: ['ubuntu-latest', 'macos-13', 'windows-latest']
     runs-on: ${{ matrix.os }}
     steps:
-    - name: Install Go
-      uses: actions/setup-go@v2
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Setup Golang
+      uses: actions/setup-go@v5
       with:
-        go-version: ${{ matrix.go-version }}
-    - name: Cache-Go
-      uses: actions/cache@v1
+        go-version: "${{ matrix.go-version }}"
+    - name: Go Test
+      run: go test -race ./...
+  module:
+    name: Test
+    permissions:
+      contents: read
+    strategy:
+      matrix:
+        go-version-file: ['go.mod']
+        os: ['ubuntu-latest', 'macos-13', 'windows-latest']
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Setup Golang
+      uses: actions/setup-go@v5
       with:
-        path: |
-          ~/go/pkg/mod              # Module download cache
-          ~/.cache/go-build         # Build cache (Linux)
-          ~/Library/Caches/go-build # Build cache (Mac)
-        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-        restore-keys: |
-          ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-    - name: Checkout code
-      uses: actions/checkout@v2
-    - name: Test
-      run: go test ./...
+        go-version-file: "${{ matrix.go-version-file }}"
+    - name: Go Test
+      run: go test -race ./...

.gitignore

@@ -1 +1,2 @@
 /.idea/
+/testdata/serialization/actual

CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contributing
+
+## Linting
+Make sure your code has been linted using [golangci-lint](https://github.com/golangci/golangci-lint?tab=readme-ov-file#install-golangci-lint)
+
+```shell
+$ golangci-lint run
+```
+
+## Tests
+
+If you want to submit a bug fix or new feature, make sure that all tests are passing.
+```shell
+$ go test ./...
+```
+
+

README.md

@@ -6,13 +6,18 @@ A  ICS / ICal parser and serialiser for Golang.
 Because the other libraries didn't quite do what I needed.
 
 Usage, parsing:
-```
+```golang
     cal, err := ParseCalendar(strings.NewReader(input))
 
 ```
 
-Creating:
+Usage, parsing from a URL :
+```golang
+    cal, err := ParseCalendar("an-ics-url")
 ```
+
+Creating:
+```golang
   cal := ics.NewCalendar()
   cal.SetMethod(ics.MethodRequest)
   event := cal.AddEvent(fmt.Sprintf("id@domain", p.SessionKey.IntID()))