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 appropriate docs for public exposure of the repo #16

Open
1 of 9 tasks
beverage opened this issue Jul 12, 2024 · 0 comments
Open
1 of 9 tasks

🧹 Add appropriate docs for public exposure of the repo #16

beverage opened this issue Jul 12, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@beverage
Copy link
Owner

beverage commented Jul 12, 2024

Lot's of busy work, including:

  • Renaming the repo - this was just supposed to be a quick test and learning app, not something I'd actually use for something.
  • A readme, duh.
  • A design section in the readme.
  • A license, in case someone is crazy enough to use this.
  • A contributing guide, in case someone is bored enough to add to this.
  • A code of conduct, in case more than one person is bored enough to add to this.
  • A help-wanted section, because this is my first ever Python project and someone seriously needs to roast this code and tell me how much it sucks.
  • A roadmap - I want to service-ify, and host this, then point an older mobile app I made at it.
  • Links to all my other presences online, and various other gizmos.

Likely more details I'm missing. All good practice items for future work.

@beverage beverage added the documentation Improvements or additions to documentation label Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant