Initial commit

.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on:
+  push:
+    branches: [ "canary" ]
+  pull_request:
+    branches: [ "canary" ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build
+        run: cargo build --verbose
+      - name: Run tests
+        run: cargo test --verbose

.gitignore

@@ -0,0 +1,36 @@
+# You can use `.git/info/exclude` to configure your local ignore list.
+
+## File system
+.DS_Store
+desktop.ini
+
+## Editor
+*.swp
+*.swo
+Session.vim
+.idea
+*.iml
+.vscode
+.project
+.vim/
+.helix/
+.zed/
+.favorites.json
+.settings/
+.vs/
+
+## Tool
+.cargo
+
+## Build
+/target
+/katharsis.config.toml
+/rss.xml
+
+## Temporary files
+*~
+\#*
+\#*\#
+.#*
+
+# Before adding new lines, see the comment at the top.

CODE_OF_CONDUCT.md

@@ -0,0 +1,47 @@
+# Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+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, and learning from the experience.
+- 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 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 address, without their explicit permission.
+- Other conduct which could reasonably be considered inappropriate in a professional setting.
+
+## Enforcement Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team responsible for enforcement. All complaints will be reviewed and investigated promptly and fairly.
+
+All project maintainers are obligated to respect the privacy and security of the reporter of any incident.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org), version [2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct).

CONTRIBUTING.md

@@ -0,0 +1,92 @@
+# Contributing to Katharsis
+
+Thank you for contributing to [Katharsis](https://github.com/kurosakishigure/katharsis). The primary way to contribute is through the [GitHub](https://github.com) platform, and we greatly appreciate every contribution you make.
+
+> - Before jumping into a PR be sure to search [existing PRs](https://github.com/kurosakishigure/katharsis/pulls) or [issues](https://github.com/kurosakishigure/katharsis/issues) for an open or closed item that relates to your submission.
+> - You need to confirm whether the PR corresponds to an issue. If there isn’t a corresponding issue, please open one before submitting the PR.
+
+## Guidelines
+
+We believe that following the guidelines when contributing to the project helps maintain a consistent style, preventing any confusion during the development process.
+
+### Documentation
+
+Here are some guidelines to maintain a consistent style and voice across the docs:
+
+- Write clear, concise sentences. Avoid tangents.
+    - If you find yourself using a lot of commas, consider breaking the sentence into multiple sentences or use a list.
+    - Swap out complex words for simpler ones. For example, use instead of utilize.
+- Be mindful with the word this. It can be ambiguous and confusing, don't be afraid to repeat the subject of the sentence if unclear.
+    - For example, Katharsis uses Rust instead of Katharsis uses this.
+- Use an active voice instead of passive. An active sentence is easier to read.
+    - For example, Katharsis uses Rust instead of Rust is used by Katharsis. If you find yourself using words like was and by you may be using a passive voice.
+- Avoid using words like easy, quick, simple, just, etc. This is subjective and can be discouraging to users.
+- Avoid negative words like don't, can't, won't, etc. This can be discouraging to readers.
+- Write in second person (you/your). This is more personal and engaging.
+- Use gender-neutral language. Use developers, users, or readers, when referring to the audience.
+- If adding code examples, ensure they are properly formatted and working.
+
+While these guidelines are not exhaustive, they should help you get started. If you'd like to dive deeper into technical writing, check out the [Google Technical Writing Course](https://developers.google.com/tech-writing/overview).
+
+### Code
+
+When you first build the project, [rustup](https://github.com/rust-lang/rustup) will automatically configure the toolchain for you based on the information in the [rust-toolchain.toml](rust-toolchain.toml) file. For more information about the toolchain, please refer to the relevant official documentation:
+
+- [The toolchain file](https://rust-lang.github.io/rustup/overrides.html#the-toolchain-file)
+- [rustfmt](https://rust-lang.github.io/rustfmt)
+- [Clippy](https://doc.rust-lang.org/clippy)
+- [rust-analyzer](https://rust-analyzer.github.io)
+
+When writing code, you need to ensure that you have the corresponding documentation and test cases, and maintain a consistent code style. Before performing any actions, such as submitting a PR or opening an issue, follow the relevant templates and process guidelines.
+
+## Code of Conduct
+
+Do note that our [Code of Conduct](CODE_OF_CONDUCT.md) applies to all Katharsis community channels. Users are **highly encouraged** to read and adhere to them to avoid repercussions.
+
+## Developing
+
+- The development branch is `canary`.
+- All pull requests should be opened against `canary`.
+
+### Dependencies
+
+- Install Rust and Cargo via [rustup](https://rustup.rs).
+- Install the [GitHub CLI](https://github.com/cli/cli#installation).
+
+### Local Development
+
+1. Clone the Katharsis repository (download only recent commits for faster clone):
+   ```bash
+   gh repo clone kurosakishigure/katharsis -- --filter=blob:none --branch canary --single-branch
+   ```
+2. Create a new branch:
+   ```bash
+   git checkout -b MY_BRANCH_NAME origin/canary
+   ```
+3. Install dependencies and build the project:
+   ```bash
+   cargo build
+   ```
+4. Run unit tests:
+   ```bash
+   cargo test
+   ```
+5. Start making changes to your code.
+   _Note: Don’t forget to run the unit tests once before committing to the branch._
+6. When your changes are finished, commit them to the branch:
+   ```bash
+   git add .
+   git commit -m "DESCRIBE_YOUR_CHANGES_HERE"
+   ```
+7. To open a pull request you can use the GitHub CLI which automatically forks and sets up a remote branch. Follow the prompts when running:
+   ```bash
+   gh pr create
+   ```
+
+## Security
+
+Once the issue has been identified, we will disclose the relevant information as soon as possible.
+
+Here are the project’s key personnel and their reporting methods:
+
+- Shigure Kurosaki - [security.txt](https://hqsy.net/.well-known/security.txt)