Contributor's Toolkit
Write Documentation
-
1
Method or Feature Docstring Update
Whenever a new method or feature is added, ensure that the corresponding docstring is updated. This maintains the readability and reliability of the codebase.
-
2
Method or Feature README Update
Whenever a new method or feature is added, ensure that the README of the project is updated. This highlights new features or methods in the project documentation.
-
3
Method or Feature Documentation Update
Whenever a new method or feature is added, ensure that the project
docs
are updated. This ensures that all new updates are properly documented and the project documentation remains current. -
4
Requesting Website Update
Whenever a new method or feature is added, ensure that a request is made to update the project's website with the new feature.