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

Write Documentation for first time contributors #47

Open
Evotushon opened this issue Oct 30, 2022 · 0 comments
Open

Write Documentation for first time contributors #47

Evotushon opened this issue Oct 30, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@Evotushon
Copy link
Contributor

A nice addition to the erupe code would be writing documentation for people who haven't worked with this code much.
Some good solutions would be:

  • Writing documentation for commonly used functions, structs, etc.
  • Making a docs folder containing:
    • Common practices to do when writing code (ex. writing make([]byte, 4) instead of []byte{0x00, 0x00, 0x00, 0x00}
    • How to setup a testing environment
    • What each directory contains (along with some files that are too "special" to not be mentioned)
@Evotushon Evotushon added the enhancement New feature or request label Oct 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Evotushon