Create a Contribution Guide
- Lenguaje dominante
- Python
- Estrellas
- 0
- Forks
- 1
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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).
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bien especificado
- Aptitud para principiantes
- 70/100