-
-
Notifications
You must be signed in to change notification settings - Fork 295
Open
Labels
Description
Description
Mixin classes have property methods lacking docstrings. Add docstrings explaining what each property returns and its purpose.
Estimated Effort
2 story points
Files to Update
backend/apps/github/models/mixins/*.pybackend/apps/owasp/models/mixins/*.py
Focus on:
backend/apps/github/models/mixins/repository.pybackend/apps/github/models/mixins/user.pybackend/apps/owasp/models/mixins/project.py
Acceptance Criteria
- Add docstrings to all property methods in the specified mixin files
- Docstrings should explain what each property returns
- Docstrings should describe the purpose of each property
- Follow existing docstring style in the codebase
- Run
make check-testlocally before submitting PR
Getting Started
- Review the contributing guidelines
- Create a feature branch
- Add docstrings to the mixin methods
- Run tests locally
- Submit a PR referencing this issue
References
- Parent issue: Good First Issues: 10 Beginner-Friendly Tasks for Backend & Frontend #2628
- Requested by: @arkid15r
Metadata
Metadata
Assignees
Labels
Type
Projects
Status
Todo