Add contribution templates and --version CLI flag (#36)

* feat(cli): add --version / -V flag

Uses importlib.metadata to read the version from the installed package.

* chore: improve bug report and feature request issue templates

- Bug report: replace web-app steps with CLI-oriented examples, add
  error output section, add Python version and LLM provider fields
- Feature request: add note directing niche features to EvoSkills,
  set default label

* chore: add documentation issue template and issue chooser config

- Add documentation template for reporting missing or unclear docs
- Add config.yml to disable blank issues and link to EvoSkills and
  Discord as contact options

* chore: add PR template and improve CONTRIBUTING.md

- Add PR template with type-of-change checkboxes, issue linking for
  new features, and CI checklist
- CONTRIBUTING.md: add development setup, PR workflow, and code style
  sections; fix wording; make Discord link clickable
This commit is contained in:
dinos
2026-03-16 16:50:19 +01:00
committed by GitHub
parent dd81a69585
commit 0303c6d43d
7 changed files with 135 additions and 26 deletions
+16 -11
View File
@@ -1,8 +1,8 @@
---
name: Bug report
about: Create a report to help us improve
about: Report a bug to help us improve EvoScientist
title: ''
labels: ''
labels: bug
assignees: ''
type: Bug
@@ -13,21 +13,26 @@ A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
1. Run `EvoSci ...`
2. Provide input '...'
3. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Error output / logs**
If applicable, paste the relevant terminal output or traceback.
```
<paste here>
```
**System information**
- OS: [e.g. Windows, MacOS, Linux]
- Terminal [e.g. iTerm2, Alacritty, Windows Terminal]
- EvoScientist Version [e.g. 0.0.1]
- OS: [e.g. Ubuntu 22.04, macOS 14.3, Windows 11]
- Python version: [e.g. 3.11.8]
- Terminal: [e.g. iTerm2, Alacritty, Windows Terminal]
- EvoScientist version: [e.g. 0.0.2 — run `EvoSci --version`]
- LLM provider: [e.g. Anthropic, OpenAI, Ollama]
**Additional context**
Add any other context about the problem here.
+8
View File
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: EvoSkills — niche features & custom workflows
url: https://github.com/EvoScientist/EvoSkills
about: Want to add a feature that serves a specific use case rather than all users? Contribute it as an EvoSkill instead.
- name: Community Discord
url: https://discord.gg/AZ9ZMXkunY
about: Ask questions, get help, and chat with the community.
+18
View File
@@ -0,0 +1,18 @@
---
name: Documentation
about: Report missing, incorrect, or unclear documentation
title: ''
labels: documentation
assignees: ''
type: Documentation
---
**What documentation is affected?**
Describe which part of the project needs better docs.
**What is wrong or missing?**
Describe the issue — is something inaccurate, outdated, hard to follow, or missing entirely?
**Suggested improvement**
If you have a specific fix or addition in mind, describe it here.
+6 -3
View File
@@ -1,15 +1,18 @@
---
name: Feature request
about: Suggest an idea for this project
about: Suggest an idea for EvoScientist core functionality
title: ''
labels: ''
labels: enhancement
assignees: ''
type: Feature
---
> **Note:** We only accept feature requests for core functionality that benefits the majority of users.
> If your idea is a niche workflow or personal utility, consider contributing it to [EvoSkills](https://github.com/EvoScientist/EvoSkills) instead.
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
A clear and concise description of the problem. Ex. "I'm always frustrated when [...]"
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
+21
View File
@@ -0,0 +1,21 @@
## Description
<!-- What does this PR do? Link the related issue (e.g. "Closes #123"). -->
## Type of change
<!-- Check the one that applies. -->
- [ ] Bug fix
- [ ] New feature — link issue: #<!-- issue number -->
- [ ] Documentation / examples
- [ ] Test improvement
- [ ] Refactor (no behavior change)
## Checklist
- [ ] I have read the [Contributing Guidelines](../CONTRIBUTING.md)
- [ ] This targets **core functionality** used by the majority of users (niche features belong in [EvoSkills](https://github.com/EvoScientist/EvoSkills))
- [ ] I have added/updated tests where applicable
- [ ] `uv run ruff check .` passes
- [ ] `uv run pytest` passes