-
Notifications
You must be signed in to change notification settings - Fork 55
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
While do occasionally have issues labeled as "Good First Issues", there often aren't a lot of issues that newcomers could jump into. To save ourselves some brainpower when we have to determine what to give new developers, it may be a good idea to come up with some broad categories of beginner issues that don't necessarily need to be explicitly listed as issues but can be brought up as necessary.
In some cases, we can leverage the unfamiliarity or inexperience of new developers to identify areas within our code which are not clear and could be made better.
This could be something we include on Notion.
Possible beginner issues include:
- Having them set up and test the existing application locally, to ensure they can understand it and that the documentation is suitable
- Going through the README or other documentation to ensure it is comprehensible, and to identify areas that need further clarification
- Going through existing code and identifying areas that need clear comments, or which could be refactored for better readability and maintainability
- Identifying and remove unused or deprecated code.
- Creating or refining user guides or tutorials
- Creating unit or integration tests for parts of the code which lack test coverage, or refactoring existing test cases.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation