mirror of
https://github.com/kjanat/articulate-parser.git
synced 2026-01-16 06:22:09 +01:00
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.
This commit is contained in:
20
.github/CODE_OF_CONDUCT.md
vendored
20
.github/CODE_OF_CONDUCT.md
vendored
@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
|
|||||||
Examples of behavior that contributes to a positive environment for our
|
Examples of behavior that contributes to a positive environment for our
|
||||||
community include:
|
community include:
|
||||||
|
|
||||||
* Demonstrating empathy and kindness toward other people
|
- Demonstrating empathy and kindness toward other people
|
||||||
* Being respectful of differing opinions, viewpoints, and experiences
|
- Being respectful of differing opinions, viewpoints, and experiences
|
||||||
* Giving and gracefully accepting constructive feedback
|
- Giving and gracefully accepting constructive feedback
|
||||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
- Accepting responsibility and apologizing to those affected by our mistakes,
|
||||||
and learning from the experience
|
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
|
overall community
|
||||||
|
|
||||||
Examples of unacceptable behavior include:
|
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
|
advances of any kind
|
||||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
- Trolling, insulting or derogatory comments, and personal or political attacks
|
||||||
* Public or private harassment
|
- Public or private harassment
|
||||||
* Publishing others' private information, such as a physical or email
|
- Publishing others' private information, such as a physical or email
|
||||||
address, without their explicit permission
|
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
|
professional setting
|
||||||
|
|
||||||
## Enforcement Responsibilities
|
## Enforcement Responsibilities
|
||||||
|
|||||||
6
.github/dependabot.yml
vendored
6
.github/dependabot.yml
vendored
@ -5,6 +5,9 @@ updates:
|
|||||||
directory: '/'
|
directory: '/'
|
||||||
schedule:
|
schedule:
|
||||||
interval: 'weekly'
|
interval: 'weekly'
|
||||||
|
day: 'monday'
|
||||||
|
time: '07:00'
|
||||||
|
timezone: 'Europe/Amsterdam'
|
||||||
open-pull-requests-limit: 10
|
open-pull-requests-limit: 10
|
||||||
labels:
|
labels:
|
||||||
- 'dependencies'
|
- 'dependencies'
|
||||||
@ -18,6 +21,9 @@ updates:
|
|||||||
directory: '/'
|
directory: '/'
|
||||||
schedule:
|
schedule:
|
||||||
interval: 'weekly'
|
interval: 'weekly'
|
||||||
|
day: 'monday'
|
||||||
|
time: '07:00'
|
||||||
|
timezone: 'Europe/Amsterdam'
|
||||||
open-pull-requests-limit: 10
|
open-pull-requests-limit: 10
|
||||||
labels:
|
labels:
|
||||||
- 'dependencies'
|
- 'dependencies'
|
||||||
|
|||||||
37
.github/release.yml
vendored
Normal file
37
.github/release.yml
vendored
Normal file
@ -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:
|
||||||
|
- "*"
|
||||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@ -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.
|
||||||
30
README.md
30
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.
|
A Go-based parser that converts Articulate Rise e-learning content to various formats including Markdown and Word documents.
|
||||||
|
|
||||||
|
[][gomod]
|
||||||
|
<!-- [][Package documentation] -->
|
||||||
|
<!-- [][Go report] -->
|
||||||
|
[][Tags]
|
||||||
|
[][Latest release]
|
||||||
|
[](LICENSE)
|
||||||
|
[][Commits]
|
||||||
|
[][Commits]
|
||||||
|
[][Issues]
|
||||||
|
[][Build]
|
||||||
|
[][Codecov]
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Parse Articulate Rise JSON data from URLs or local files
|
- Parse Articulate Rise JSON data from URLs or local files
|
||||||
@ -140,6 +152,14 @@ The parser includes error handling for:
|
|||||||
- File I/O errors
|
- File I/O errors
|
||||||
- Unsupported content types
|
- Unsupported content types
|
||||||
|
|
||||||
|
<!-- ## Code coverage
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
 -->
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
||||||
- Media files (videos, images) are referenced but not downloaded
|
- Media files (videos, images) are referenced but not downloaded
|
||||||
@ -161,3 +181,13 @@ Potential improvements could include:
|
|||||||
## License
|
## License
|
||||||
|
|
||||||
This is a utility tool for educational content conversion. Please ensure you have appropriate rights to the Articulate Rise content you're parsing.
|
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
|
||||||
|
|||||||
Reference in New Issue
Block a user