Implement encode/decode

[nao1215]

Summary by CodeRabbit

• New Features

  • Added encoding and decoding functionality for Clockwork Base32 library
  • Introduced comprehensive documentation for library usage and contribution

• Documentation

  • Updated CHANGELOG.md with first release details and release date
  • Expanded README.md with Haskell module example, supported versions, and contribution guidelines
  • Added detailed CONTRIBUTING.md guidelines for developers and non-coders

• Tests

  • Added test cases for encoding and decoding functions
  • Removed tests for the previous maxInList function

• Chores

  • Updated GitHub Actions workflow to include additional GHC versions and renamed job from "build" to "test"
  • Changed category in cabal file from "Web" to "Base32"

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces substantial updates to the clockwork-base32 library, enhancing its functionality with Base32 encoding and decoding capabilities. Key changes include updating the changelog to reflect the first release date, expanding the contributing guidelines for developers and non-coders, adding a module example and usage in the README, implementing the core encoding and decoding functions in the source code, and revising the test suite to cover the new functionalities.

Changes

File	Changes
CHANGELOG.md	- Updated release date to 2025-01-15 - Added first release entry
CONTRIBUTING.md	- Added "Contributing as a Developer" section - Added "Contributing Outside of Coding" section
README.md	- Added Haskell module example - Included main function demonstrating encoding/decoding - Added Contributing and Contact sections - Expanded LICENSE section referencing MIT License
src/ClockworkBase32.hs	- Removed maxInList function - Added encode function for Base32 encoding - Added decode function for Base32 decoding
test/Spec.hs	- Removed maxInList tests - Added tests for encode function - Added tests for decode function
.github/workflows/test.yml	- Renamed job from build to test - Expanded GHC version matrix to include more versions
clockwork-base32.cabal	- Updated category from Web to Base32

Sequence Diagram

sequenceDiagram
    participant User
    participant ClockworkBase32
    
    User->>ClockworkBase32: encode("Hello")
    ClockworkBase32-->>User: Encoded Base32 string
    
    User->>ClockworkBase32: decode(encodedString)
    ClockworkBase32-->>User: Original string or Error

Loading

Poem

🐰 A Rabbit's Ode to Base32 Delight 🔢
In bytes we dance, encode with glee,
From strings to symbols, set them free!
Five bits here, eight bits there,
A coding waltz beyond compare.
Clockwork magic, Base32's might! 🚀

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between 9877a7c and e5c8ad1.

📒 Files selected for processing (1)

• clockwork-base32.cabal (1 hunks)

---

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.