Create a Contribution Guide
@aafre is already working on this.
Since Aug 8, 2025.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 70/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Domain
- documentation
Research direction
Create a new CONTRIBUTING.md file in the project root. Follow the acceptance criteria: include a welcome message, how to contribute (finding issues, forking, branching, PRs), link to the README's 'Development Setup' section, mention ruff for linting/formatting, and specify the test command (uv run pytest or pytest -v). Review the existing README.md for style and consistency.
Written by the indexing model from the issue text.
Description
To make it easier for new contributors to join the project, we need a clear CONTRIBUTING.md file that outlines the process for setting up the development environment and submitting changes.
This is a great non-code contribution for someone who wants to help with the project's community standards.
Acceptance Criteria
A new file named CONTRIBUTING.md is created in the project root.
The file should contain the following sections:
- Welcome Message: A brief, welcoming paragraph.
- How to Contribute: Instructions on how to find an issue (especially good first issue), fork the repository, create a new branch, and submit a pull request.
- Setting Up the Development Environment: A link to the "Development Setup" section of the README.md.
- Code Style & Linting: A brief mention that we use ruff for linting and formatting and that the CI will check this.
- Running Tests: The command to run the test suite (uv run pytest or pytest -v).
- Dominant language
- Python
- Stars
- 0
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from aafre/artisan-engine
-
good first issue help wanted Python
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
aafre/artisan-engine#9 · 1 assignee ·
-
api enhancement Python
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
aafre/artisan-engine#7 · 1 assignee ·
-
developer-experience documentation good first issue
Difficulty 1/5 Under an hour Newbie friendliness 75/100
aafre/artisan-engine#6 · 1 assignee ·
-
api enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 40/100
aafre/artisan-engine#15 · 2 comments · 1 assignee ·
-
high-priority testing
Difficulty 3/5 1-2 days Newbie friendliness 65/100
aafre/artisan-engine#14 ·
All issues in aafre/artisan-engine
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100