Create contribution.md #42
Conversation
complete contribution markdown
| pip install . | ||
| ``` | ||
|
|
||
| 3. **Set Up Development Tools (Optional but Recommended):** |
There was a problem hiding this comment.
This bit should be covered by the pyproject.toml and automatically install dev-dependencies. Correct? @Lagyamfi .
I think linting and formatting should be mandatory
There was a problem hiding this comment.
There should a way to install dev-dependencies using poetry @PhidLarkson
There was a problem hiding this comment.
Alright I would be adding black and ruff too
contribution.md
Outdated
|
|
||
| 1. **Create a Branch:** | ||
| Create a branch for your work. Use a meaningful name that hints at the purpose (e.g., `feature-enhance-translation`): | ||
| ```bash |
There was a problem hiding this comment.
I'm not sure we need to specify here exactly what git commands to use. It would differ based on the contributors workflow whether terminal or gui based. We can describe here what is expected generally and probably not step by step
There was a problem hiding this comment.
Alright well noted, I will sort that out in a bit
|
|
||
| 2. **Add New Test Cases:** | ||
| If your feature or bug fix requires new tests, create them to ensure comprehensive coverage. | ||
|
|
There was a problem hiding this comment.
We should have a step here for running linting
Contribution.md, a standalone markdown file with regular updates as to how to set up and what to do in your editor