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.

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

Add some more documentation to code #341

Open
Ma-wa-re opened this issue May 2, 2020 · 0 comments
Open

Add some more documentation to code #341

Ma-wa-re opened this issue May 2, 2020 · 0 comments

Comments

@Ma-wa-re
Copy link
Member

Ma-wa-re commented May 2, 2020

More people are starting to want add features to futaba so it would be a good idea to start making sure everything is documented to a reasonable level.
Such as:

  • Function headers to explain briefly what it is doing
  • Update the wiki (see Finish adding docs to futaba wiki #239) to explain where to find each feature in the codebase.
  • How we want PRs/issue raised etc
  • Setting up a dev environment for it

Just stuff like that in general, its most likely going to be a big task but will help new user on adding features

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant