Enhances project setup and configuration

Updates code of conduct formatting and adds Dependabot schedule for Monday at 07:00 in the Europe/Amsterdam timezone. Introduces release config for automatic note generation categorized by type and adds a LICENSE file with MIT License. Renames Go module for better clarity and updates README with badges for better project tracking and visibility.
2026-01-16 08:22:09 +01:00 · 2025-05-24 20:40:18 +02:00
parent dc580ed769
commit bb37ebdfea
6 changed files with 105 additions and 11 deletions
--- a/.github/CODE_OF_CONDUCT.md
+++ b/.github/CODE_OF_CONDUCT.md
@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:

-*   Demonstrating empathy and kindness toward other people
-*   Being respectful of differing opinions, viewpoints, and experiences
-*   Giving and gracefully accepting constructive feedback
-*   Accepting responsibility and apologizing to those affected by our mistakes,
+-   Demonstrating empathy and kindness toward other people
+-   Being respectful of differing opinions, viewpoints, and experiences
+-   Giving and gracefully accepting constructive feedback
+-   Accepting responsibility and apologizing to those affected by our mistakes,
  and learning from the experience
-*   Focusing on what is best not just for us as individuals, but for the
+-   Focusing on what is best not just for us as individuals, but for the
  overall community

 Examples of unacceptable behavior include:

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

 ## Enforcement Responsibilities
--- a/.github/dependabot.yml
+++ b/.github/dependabot.yml
@ -5,6 +5,9 @@ updates:
    directory: '/'
    schedule:
      interval: 'weekly'
+      day: 'monday'
+      time: '07:00'
+      timezone: 'Europe/Amsterdam'
    open-pull-requests-limit: 10
    labels:
      - 'dependencies'
@ -18,6 +21,9 @@ updates:
    directory: '/'
    schedule:
      interval: 'weekly'
+      day: 'monday'
+      time: '07:00'
+      timezone: 'Europe/Amsterdam'
    open-pull-requests-limit: 10
    labels:
      - 'dependencies'
--- a/.github/release.yml
+++ b/.github/release.yml
@ -0,0 +1,37 @@
+# .github/release.yml
+# Configuration for GitHub's automatically generated release notes
+# Reference: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
+
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+    authors:
+      - dependabot
+  categories:
+    - title: 🚀 New Features
+      labels:
+        - enhancement
+        - feature
+    - title: 🐛 Bug Fixes
+      labels:
+        - bug
+        - bugfix
+        - fix
+    - title: 📚 Documentation
+      labels:
+        - documentation
+    - title: 🧪 Tests
+      labels:
+        - test
+        - testing
+    - title: 🔧 Maintenance
+      labels:
+        - chore
+        - maintenance
+    - title: ⬆️ Dependencies
+      labels:
+        - dependencies
+    - title: 🧰 Other Changes
+      labels:
+        - "*"
--- a/21
+++ b/21
@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Kaj "kjanat" Kowalski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
--- a/README.md
+++ b/README.md
@ -2,6 +2,18 @@

 A Go-based parser that converts Articulate Rise e-learning content to various formats including Markdown and Word documents.

+[![Go version](https://img.shields.io/github/go-mod/go-version/kjanat/articulate-parser?logo=Go&logoColor=white)][gomod]
+<!-- [![Go Doc](https://godoc.org/github.com/kjanat/articulate-parser?status.svg)][Package documentation] -->
+<!-- [![Go Report Card](https://goreportcard.com/badge/github.com/kjanat/articulate-parser)][Go report] -->
+[![Tag](https://img.shields.io/github/v/tag/kjanat/articulate-parser?sort=semver&label=Tag)][Tags]
+[![Release Date](https://img.shields.io/github/release-date/kjanat/articulate-parser?label=Release%20date)][Latest release]
+[![License](https://img.shields.io/github/license/kjanat/articulate-parser?label=License)](LICENSE)
+[![Commit activity](https://img.shields.io/github/commit-activity/m/kjanat/articulate-parser?label=Commit%20activity)][Commits]
+[![Last commit](https://img.shields.io/github/last-commit/kjanat/articulate-parser?label=Last%20commit)][Commits]
+[![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/kjanat/articulate-parser?label=Issues)][Issues]
+[![CI](https://img.shields.io/github/actions/workflow/status/kjanat/articulate-parser/ci.yml?logo=github&label=CI)][Build]
+[![Codecov](https://img.shields.io/codecov/c/gh/kjanat/articulate-parser?token=eHhaHY8nut&logo=codecov&logoColor=%23F01F7A&label=Codecov)][Codecov]
+
 ## Features

 -   Parse Articulate Rise JSON data from URLs or local files
@ -140,6 +152,14 @@ The parser includes error handling for:
 -   File I/O errors
 -   Unsupported content types

+<!-- ## Code coverage
+
+![Sunburst](https://codecov.io/gh/kjanat/articulate-parser/graphs/tree.svg?token=eHhaHY8nut)
+
+![Grid](https://codecov.io/gh/kjanat/articulate-parser/graphs/tree.svg?token=eHhaHY8nut)
+
+![Icicle](https://codecov.io/gh/kjanat/articulate-parser/graphs/icicle.svg?token=eHhaHY8nut) -->
+
 ## Limitations

 -   Media files (videos, images) are referenced but not downloaded
@ -161,3 +181,13 @@ Potential improvements could include:
 ## License

 This is a utility tool for educational content conversion. Please ensure you have appropriate rights to the Articulate Rise content you're parsing.
+
+[Build]: https://github.com/kjanat/articulate-parser/actions/workflows/ci.yml
+[Codecov]: https://codecov.io/gh/kjanat/articulate-parser
+[Commits]: https://github.com/kjanat/articulate-parser/commits/master/
+[Go report]: https://goreportcard.com/report/github.com/kjanat/articulate-parser
+[gomod]: go.mod
+[Issues]: https://github.com/kjanat/articulate-parser/issues
+[Latest release]: https://github.com/kjanat/articulate-parser/releases/latest
+[Package documentation]: https://godoc.org/github.com/kjanat/articulate-parser
+[Tags]: https://github.com/kjanat/articulate-parser/tags
--- a/go.mod
+++ b/go.mod
@ -1,4 +1,4 @@
-module articulate-parser
+module github.com/kjanat/articulate-parser

 go 1.21