Add documentation, templates, and contributing guidelines

[mkh-user]

• Add issue and PR templates
• Add changelog
• Add code of conduct
• Add contributing guide
• Add development setup guide

Summary by CodeRabbit

• Documentation

  • Added contributing guide, development setup, SECURITY policy, Code of Conduct, and an updated changelog.

• Chores

  • Added structured issue and pull-request templates for bug, feature, docs, performance, and general reports.
  • Disabled blank issues and added contact links for discussions and security.
  • Updated CI triggers to run on push events only.

[coderabbitai]

Warning

Rate limit exceeded

@mkh-user has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 14 minutes and 51 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📝 Walkthrough

Walkthrough

Adds repository governance and contributor tooling: multiple GitHub issue templates and config, a PR template, CODE_OF_CONDUCT, SECURITY policy, contributor and development docs, an updated CHANGELOG, and a minor CI workflow trigger normalization.

Changes

Cohort / File(s)	Summary
Issue Templates & Config .github/ISSUE_TEMPLATE/bug-report.yml, .github/ISSUE_TEMPLATE/documentation-improvement.yml, .github/ISSUE_TEMPLATE/feature-request.yml, .github/ISSUE_TEMPLATE/general-issue.yml, .github/ISSUE_TEMPLATE/performance-issue.yml, .github/ISSUE_TEMPLATE/config.yml	Adds five structured issue templates with metadata, required fields, checklists, dropdowns, placeholders, and validation; disables blank issues and adds contact_links in config.
Pull Request Template .github/pull_request_template.md	Adds a comprehensive PR template with sections for issue linkage, description, change type, implementation details, testing, reviewers, and a checklist.
Governance Files CODE_OF_CONDUCT.md, SECURITY.md	Adds a Contributor Covenant-style Code of Conduct and a SECURITY.md describing reporting, response process, and disclosure guidelines.
Contributor Documentation docs/CONTRIBUTING.md, docs/development-setup.md	Adds contributor guide and development setup docs covering workflow, branching, coding standards, testing, and local environment setup.
Changelog CHANGELOG.md	Adds a full changelog with an Unreleased section and historical release entries through v0.2.2.
CI Workflow tweak .github/workflows/pytest.yml	Adjusts workflow triggers to normalize branch naming/triggers (push/PR trigger change noted).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

🐰
In a burrow of files I neatly hop,
Templates and rules — I stacked them on top.
Guides, conduct, and changelog in tow,
Now contributors know where to go.
Hooray! 🥕✨

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly summarizes the main changes: adding documentation, templates, and contributing guidelines, which aligns with the file additions across issue templates, PR template, changelog, code of conduct, and contribution guides.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection	✅ Passed	✅ No merge conflicts detected when merging into main

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch dev

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 3

🤖 Fix all issues with AI agents

In @.github/workflows/pytest.yml:
- Line 4: The workflow currently sets the GitHub Actions trigger as on: [push],
which stops CI from running on pull requests; update the workflow's on
configuration to include pull_request (e.g., change the on entry that currently
reads "on: [push]" to include "pull_request") so PRs (including forks) run the
same test suite; look for the top-level on key in the
.github/workflows/pytest.yml (the line containing on: [push]) and add
pull_request to that list.

In `@CHANGELOG.md`:
- Line 18: The CHANGLE entry "Missing version increasing." is awkward; update
the line in CHANGELOG.md to a clearer phrasing such as "Version number not
incremented" or "Fixed version numbering" (or another idiomatic alternative) so
the changelog reads naturally and accurately.

In `@docs/development-setup.md`:
- Around line 80-83: Update the test-running step so it matches CI by changing
the single-line "pytest" instruction to run tests from the tests directory
(i.e., use "cd ./tests && pytest" or instruct users to first "cd ./tests" then
run "pytest"); modify the snippet that currently only shows "pytest" to
explicitly change directory before invoking pytest so local runs mirror the CI
workflow.