Skip to content

Commit a1a49a7

Browse files
committed
chore: Enhance developer tooling and documentation
Adds `actionlint` to the pre-commit configuration to validate GitHub Actions workflows. Significantly expands the `AGENTS.md` file with a comprehensive summary of new features and changes in Go 1.24 and 1.25, along with actionable recommendations for the project. Additionally, normalizes markdown list formatting across various documentation files for consistency.
1 parent 8d60670 commit a1a49a7

File tree

10 files changed

+676
-283
lines changed

10 files changed

+676
-283
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/CONTRIBUTING.md

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -12,52 +12,52 @@ This project and everyone participating in it is governed by our Code of Conduct
1212

1313
Before creating bug reports, please check existing issues as you might find that the issue has already been reported. When creating a bug report, include as many details as possible:
1414

15-
- Use the bug report template
16-
- Include sample Articulate Rise content that reproduces the issue
17-
- Provide your environment details (OS, Go version, etc.)
18-
- Include error messages and stack traces
15+
- Use the bug report template
16+
- Include sample Articulate Rise content that reproduces the issue
17+
- Provide your environment details (OS, Go version, etc.)
18+
- Include error messages and stack traces
1919

2020
### Suggesting Enhancements
2121

2222
Enhancement suggestions are welcome! Please use the feature request template and include:
2323

24-
- A clear description of the enhancement
25-
- Your use case and why this would be valuable
26-
- Any implementation ideas you might have
24+
- A clear description of the enhancement
25+
- Your use case and why this would be valuable
26+
- Any implementation ideas you might have
2727

2828
### Pull Requests
2929

30-
1. **Fork the repository** and create your branch from `master`
31-
2. **Make your changes** following our coding standards
32-
3. **Add tests** for any new functionality
33-
4. **Ensure all tests pass** by running `go test ./...`
34-
5. **Run `go fmt`** to format your code
35-
6. **Run `go vet`** to check for common issues
36-
7. **Update documentation** if needed
37-
8. **Create a pull request** with a clear title and description
30+
1. **Fork the repository** and create your branch from `master`
31+
2. **Make your changes** following our coding standards
32+
3. **Add tests** for any new functionality
33+
4. **Ensure all tests pass** by running `go test ./...`
34+
5. **Run `go fmt`** to format your code
35+
6. **Run `go vet`** to check for common issues
36+
7. **Update documentation** if needed
37+
8. **Create a pull request** with a clear title and description
3838

3939
## Development Setup
4040

41-
1. **Prerequisites:**
41+
1. **Prerequisites:**
4242

43-
- Go 1.21 or later
44-
- Git
43+
- Go 1.21 or later
44+
- Git
4545

46-
2. **Clone and setup:**
46+
2. **Clone and setup:**
4747

4848
```bash
4949
git clone https://github.com/your-username/articulate-parser.git
5050
cd articulate-parser
5151
go mod download
5252
```
5353

54-
3. **Run tests:**
54+
3. **Run tests:**
5555

5656
```bash
5757
go test -v ./...
5858
```
5959

60-
4. **Build:**
60+
4. **Build:**
6161

6262
```bash
6363
go build main.go
@@ -67,18 +67,18 @@ Enhancement suggestions are welcome! Please use the feature request template and
6767

6868
### Go Style Guide
6969

70-
- Follow the [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments)
71-
- Use `gofmt` to format your code
72-
- Use meaningful variable and function names
73-
- Add comments for exported functions and types
74-
- Keep functions focused and small
70+
- Follow the [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments)
71+
- Use `gofmt` to format your code
72+
- Use meaningful variable and function names
73+
- Add comments for exported functions and types
74+
- Keep functions focused and small
7575

7676
### Testing
7777

78-
- Write tests for new functionality
79-
- Use table-driven tests where appropriate
80-
- Aim for good test coverage
81-
- Test error cases and edge conditions
78+
- Write tests for new functionality
79+
- Use table-driven tests where appropriate
80+
- Aim for good test coverage
81+
- Test error cases and edge conditions
8282

8383
### Commit Messages
8484

@@ -112,19 +112,19 @@ articulate-parser/
112112

113113
### New Content Types
114114

115-
1. Add the content type definition to `types/`
116-
2. Implement parsing logic in `parser/`
117-
3. Add export handling in `exporters/`
118-
4. Write comprehensive tests
119-
5. Update documentation
115+
1. Add the content type definition to `types/`
116+
2. Implement parsing logic in `parser/`
117+
3. Add export handling in `exporters/`
118+
4. Write comprehensive tests
119+
5. Update documentation
120120

121121
### New Export Formats
122122

123-
1. Create a new exporter in `exporters/`
124-
2. Implement the `Exporter` interface
125-
3. Add CLI support in `main.go`
126-
4. Add tests with sample output
127-
5. Update README with usage examples
123+
1. Create a new exporter in `exporters/`
124+
2. Implement the `Exporter` interface
125+
3. Add CLI support in `main.go`
126+
4. Add tests with sample output
127+
5. Update README with usage examples
128128

129129
## Testing
130130

@@ -146,31 +146,31 @@ go test -run TestSpecificFunction ./...
146146

147147
### Test Data
148148

149-
- Add sample Articulate Rise JSON files to `tests/data/`
150-
- Include both simple and complex content examples
151-
- Test edge cases and error conditions
149+
- Add sample Articulate Rise JSON files to `tests/data/`
150+
- Include both simple and complex content examples
151+
- Test edge cases and error conditions
152152

153153
## Documentation
154154

155-
- Update the README for user-facing changes
156-
- Add inline code comments for complex logic
157-
- Update examples when adding new features
158-
- Keep the feature list current
155+
- Update the README for user-facing changes
156+
- Add inline code comments for complex logic
157+
- Update examples when adding new features
158+
- Keep the feature list current
159159

160160
## Release Process
161161

162162
Releases are handled by maintainers:
163163

164-
1. Version bumping follows semantic versioning
165-
2. Releases are created from the `master` branch
166-
3. GitHub Actions automatically builds and publishes releases
167-
4. Release notes are auto-generated from commits
164+
1. Version bumping follows semantic versioning
165+
2. Releases are created from the `master` branch
166+
3. GitHub Actions automatically builds and publishes releases
167+
4. Release notes are auto-generated from commits
168168

169169
## Questions?
170170

171-
- Open a discussion for general questions
172-
- Use the question issue template for specific help
173-
- Check existing issues and documentation first
171+
- Open a discussion for general questions
172+
- Use the question issue template for specific help
173+
- Check existing issues and documentation first
174174

175175
## Recognition
176176

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Fixes #
1010
## Type of Change
1111

1212
<!-- Mark the appropriate option with an "x" -->
13-
- [ ] Bug fix (non-breaking change which fixes an issue)
14-
- [ ] New feature (non-breaking change which adds functionality)
15-
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
16-
- [ ] Documentation update
17-
- [ ] Performance improvement
18-
- [ ] Code refactoring (no functional changes)
19-
- [ ] Test updates
13+
- [ ] Bug fix (non-breaking change which fixes an issue)
14+
- [ ] New feature (non-breaking change which adds functionality)
15+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
16+
- [ ] Documentation update
17+
- [ ] Performance improvement
18+
- [ ] Code refactoring (no functional changes)
19+
- [ ] Test updates
2020

2121
## Checklist
2222

2323
<!-- Mark the items you've completed with an "x" -->
24-
- [ ] My code follows the style guidelines of this project
25-
- [ ] I have performed a self-review of my code
26-
- [ ] I have added comments to complex logic
27-
- [ ] I have updated the documentation
28-
- [ ] I have added tests that prove my fix is effective or that my feature works
29-
- [ ] New and existing unit tests pass locally with my changes
30-
- [ ] I have checked for potential breaking changes
31-
- [ ] No new warnings are generated
32-
- [ ] The commit message follows our guidelines
24+
- [ ] My code follows the style guidelines of this project
25+
- [ ] I have performed a self-review of my code
26+
- [ ] I have added comments to complex logic
27+
- [ ] I have updated the documentation
28+
- [ ] I have added tests that prove my fix is effective or that my feature works
29+
- [ ] New and existing unit tests pass locally with my changes
30+
- [ ] I have checked for potential breaking changes
31+
- [ ] No new warnings are generated
32+
- [ ] The commit message follows our guidelines
3333

3434
## Screenshots (if appropriate)
3535

.github/SECURITY.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,32 +13,32 @@ Currently, the following versions of Articulate Rise Parser are supported with s
1313

1414
We take the security of Articulate Rise Parser seriously. If you believe you have found a security vulnerability, please follow these steps:
1515

16-
1. **Do not disclose the vulnerability publicly** - Please do not create a public GitHub issue for security vulnerabilities.
17-
2. **Email the details to [[email protected]]** - Include as much information as possible about the vulnerability.
18-
3. **Wait for a response** - We will acknowledge your email within 48 hours and provide an estimated timeline for a fix.
19-
4. **Work with us** - We may ask for additional information to help us understand and address the issue.
16+
1. **Do not disclose the vulnerability publicly** - Please do not create a public GitHub issue for security vulnerabilities.
17+
2. **Email the details to [[email protected]]** - Include as much information as possible about the vulnerability.
18+
3. **Wait for a response** - We will acknowledge your email within 48 hours and provide an estimated timeline for a fix.
19+
4. **Work with us** - We may ask for additional information to help us understand and address the issue.
2020

2121
## What to Include in a Report
2222

2323
When reporting a vulnerability, please include:
2424

25-
- A clear description of the issue
26-
- Steps to reproduce the vulnerability
27-
- The potential impact of the vulnerability
28-
- Any possible mitigations you've identified
25+
- A clear description of the issue
26+
- Steps to reproduce the vulnerability
27+
- The potential impact of the vulnerability
28+
- Any possible mitigations you've identified
2929

3030
## What to Expect
3131

32-
- We will acknowledge receipt of your vulnerability report within 48 hours.
33-
- We will provide regular updates about our progress.
34-
- We will notify you when the vulnerability is fixed.
35-
- With your permission, we will include your name in the acknowledgments.
32+
- We will acknowledge receipt of your vulnerability report within 48 hours.
33+
- We will provide regular updates about our progress.
34+
- We will notify you when the vulnerability is fixed.
35+
- With your permission, we will include your name in the acknowledgments.
3636

3737
## Security Measures
3838

3939
This project follows these security practices:
4040

41-
- Regular dependency updates via Dependabot
42-
- CodeQL security scanning
43-
- Automated testing for each pull request
44-
- Code review requirements for all changes
41+
- Regular dependency updates via Dependabot
42+
- CodeQL security scanning
43+
- Automated testing for each pull request
44+
- Code review requirements for all changes

.github/workflows/autofix.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
- name: Setup go deps
2323
run: |
2424
# Install golangci-lint
25-
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/HEAD/install.sh | sh -s -- -b $(go env GOPATH)/bin
25+
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/HEAD/install.sh | sh -s -- -b "$(go env GOPATH)/bin"
2626
2727
# Install go-task dependencies
2828
go install golang.org/x/tools/cmd/goimports@latest

0 commit comments

Comments
 (0)