Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation #2

Open
2 tasks
noobdealer opened this issue Feb 25, 2024 · 0 comments
Open
2 tasks

Improve documentation #2

noobdealer opened this issue Feb 25, 2024 · 0 comments
Assignees
@noobdealer
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone
0.1 release

Comments

@noobdealer
Copy link
Owner

Issue

As development continues on the project, and with the possibility of other people working on the project, it will be necessary to have a readable documentation included in the codebase with Godot's docstrings and auto-documentation features.

How to resolve

  • Document more functionality with docstrings (## Comment here)
  • Build a CONTRIBUTING.md file for how to write clean and uniform code
@noobdealer noobdealer added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 25, 2024
@noobdealer noobdealer added this to the 0.1 release milestone Feb 25, 2024
@noobdealer noobdealer self-assigned this Feb 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@noobdealer noobdealer

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
0.1 release
Development

No branches or pull requests
1 participant
@noobdealer