[FEATURE REQUEST]: Developer Documentation #6
Labels
1-Meta: Issue
This is an issue.
2-Type: Documentation
Additions and/or changes to the documentation.
2-Type: Enhancement
A new feature or reworked pre-existing feature.
3-Status: Approved > Planning > Open
This isn't necessarily prioritized, but open for development nonetheless.
4-Priority: High
This needs attention soon.
5-Difficult: Low
This should be fairly straightforward to implement. This is good for new contributors.
6-Scope: GitHub
This pertains to the GitHub repository.
Is your feature request related to a problem? Please describe.
It was really only a matter of time before I made an issue for this, but we really should have some kind of style guide to ensure that the code is consistent.
Describe the solution you'd like
Probably just a folder called "documentation" or something, with markdown files for stuff. I'll figure that out.
Describe alternatives you've considered
Perhaps using the GitHub wikis feature. Although I think that's more useful for documentation that's meant to be more "user-friendly" (ergo, users who aren't going to click on the "documentation" folder). There's also just writing out concise documentation inside of our code too, which I have begun to do, but this probably won't suffice on its own.
Additional context
Not really, there's nobody else who contributes to this project so it could be seen as "useless", but whatever.
The text was updated successfully, but these errors were encountered: