Skip to content

Commit bb37ebd

Browse files
committed
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.
1 parent dc580ed commit bb37ebd

File tree

6 files changed

+105
-11
lines changed

6 files changed

+105
-11
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
1717
Examples of behavior that contributes to a positive environment for our
1818
community include:
1919

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

2828
Examples of unacceptable behavior include:
2929

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

3939
## Enforcement Responsibilities

.github/dependabot.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ updates:
55
directory: '/'
66
schedule:
77
interval: 'weekly'
8+
day: 'monday'
9+
time: '07:00'
10+
timezone: 'Europe/Amsterdam'
811
open-pull-requests-limit: 10
912
labels:
1013
- 'dependencies'
@@ -18,6 +21,9 @@ updates:
1821
directory: '/'
1922
schedule:
2023
interval: 'weekly'
24+
day: 'monday'
25+
time: '07:00'
26+
timezone: 'Europe/Amsterdam'
2127
open-pull-requests-limit: 10
2228
labels:
2329
- 'dependencies'

.github/release.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# .github/release.yml
2+
# Configuration for GitHub's automatically generated release notes
3+
# Reference: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
4+
5+
changelog:
6+
exclude:
7+
labels:
8+
- ignore-for-release
9+
authors:
10+
- dependabot
11+
categories:
12+
- title: 🚀 New Features
13+
labels:
14+
- enhancement
15+
- feature
16+
- title: 🐛 Bug Fixes
17+
labels:
18+
- bug
19+
- bugfix
20+
- fix
21+
- title: 📚 Documentation
22+
labels:
23+
- documentation
24+
- title: 🧪 Tests
25+
labels:
26+
- test
27+
- testing
28+
- title: 🔧 Maintenance
29+
labels:
30+
- chore
31+
- maintenance
32+
- title: ⬆️ Dependencies
33+
labels:
34+
- dependencies
35+
- title: 🧰 Other Changes
36+
labels:
37+
- "*"

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Kaj "kjanat" Kowalski
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22

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

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

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

155+
<!-- ## Code coverage
156+
157+
![Sunburst](https://codecov.io/gh/kjanat/articulate-parser/graphs/tree.svg?token=eHhaHY8nut)
158+
159+
![Grid](https://codecov.io/gh/kjanat/articulate-parser/graphs/tree.svg?token=eHhaHY8nut)
160+
161+
![Icicle](https://codecov.io/gh/kjanat/articulate-parser/graphs/icicle.svg?token=eHhaHY8nut) -->
162+
143163
## Limitations
144164

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

163183
This is a utility tool for educational content conversion. Please ensure you have appropriate rights to the Articulate Rise content you're parsing.
184+
185+
[Build]: https://github.com/kjanat/articulate-parser/actions/workflows/ci.yml
186+
[Codecov]: https://codecov.io/gh/kjanat/articulate-parser
187+
[Commits]: https://github.com/kjanat/articulate-parser/commits/master/
188+
[Go report]: https://goreportcard.com/report/github.com/kjanat/articulate-parser
189+
[gomod]: go.mod
190+
[Issues]: https://github.com/kjanat/articulate-parser/issues
191+
[Latest release]: https://github.com/kjanat/articulate-parser/releases/latest
192+
[Package documentation]: https://godoc.org/github.com/kjanat/articulate-parser
193+
[Tags]: https://github.com/kjanat/articulate-parser/tags

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module articulate-parser
1+
module github.com/kjanat/articulate-parser
22

33
go 1.21
44

0 commit comments

Comments
 (0)