Skip to content

Add CONTRIBUTING.md and issue templates#86

Closed
fuleinist wants to merge 1 commit intolsdefine:mainfrom
fuleinist:add-contributing-and-issues
Closed

Add CONTRIBUTING.md and issue templates#86
fuleinist wants to merge 1 commit intolsdefine:mainfrom
fuleinist:add-contributing-and-issues

Conversation

@fuleinist
Copy link
Copy Markdown

Summary

Addresses issue #64 — adds contributor documentation and structured issue templates to improve the open-source contributor experience.

Changes

  • CONTRIBUTING.md: Code style guide (PEP 8, dataclasses, generators), project structure overview, branch strategy, PR checklist, and testing instructions.
  • Bug Report template: Structured template for bug reports with environment info and reproduction steps.
  • Feature Request template: Template for enhancements with problem/solution/use-case sections.
  • Question template: For Q&A, with a link to Discussions.
  • config.yml: Template chooser pointing users to Discussions for general questions.

Why This Helps

The repo currently has no contributor onboarding docs. External contributors don't know the code style, testing expectations, or branch strategy. Issue #64 identified this as a key friction point. These docs lower the barrier to meaningful contributions.

…ence

- CONTRIBUTING.md: code style, project structure, PR checklist, testing guide
- Bug Report template
- Feature Request template
- Question template
- Template configuration pointing to Discussions
@lsdefine
Copy link
Copy Markdown
Owner

Thanks @fuleinist for the PR and for following up on #64!

We've just added our own CONTRIBUTING.md (commit 9dbb331) — it takes a deliberately different approach from the traditional format. It's 44 lines, and the first section explains why: this repo is read by AI agents constantly, so every extra line has a real cost in tokens and context window.

The skill contribution model and PR checklist are covered, just... compressed. Feel free to check it out.

Closing this one since we've landed our version. Thanks for the push to get this done — it helped. 🙏

@lsdefine lsdefine closed this Apr 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants