#9 Improve documentation for contributors

Closed
opened 7 months ago by steko · 1 comments
steko commented 7 months ago
Owner

The current documentation is lacking. Based on this set of guidelines https://github.com/kylelobo/The-Documentation-Compendium ideally there should be 3 blocks of documentation:

  • contributing (how to submit a pull request)
  • codebase structure (describe each module)
  • coding guidelines (e.g. "use black")
The current documentation is lacking. Based on this set of guidelines https://github.com/kylelobo/The-Documentation-Compendium ideally there should be 3 blocks of documentation: - contributing (how to submit a pull request) - codebase structure (describe each module) - coding guidelines (e.g. "use black")
steko added this to the v0.5.0 milestone 7 months ago
steko added the
enhancement
label 7 months ago
steko self-assigned this 7 months ago
steko commented 5 months ago
Poster
Owner

Fixed in 19a91a9564

Fixed in 19a91a9564
steko closed this issue 5 months ago
Sign in to join this conversation.
No Milestone
No project
No Assignees
1 Participants
Notifications
Due Date

No due date set.

Dependencies

This issue currently doesn't have any dependencies.

Loading…
There is no content yet.