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

[Bug]: Missing documentation #2

Open
3 tasks done
dmohns opened this issue Dec 9, 2024 · 0 comments
Open
3 tasks done

[Bug]: Missing documentation #2

dmohns opened this issue Dec 9, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@dmohns
Copy link
Member

dmohns commented Dec 9, 2024

Preflight Checklist

Expected Behavior

The repository should be equipped with documentation and contribution guide.

Please add the following:

  • A README file which gives a high-level overview of the application. Covering: What it does, tech stack, frameworks used
  • Documentation explaining, how the app works and instructions on how to build and publish
  • Github Actions CI/CD to enforce Code style

Actual Behavior

This repository is essentially a code dump without any kind of information or documentation.

Steps to reproduce

N/A

What operating system(s) are you using?

macOS

Additional Information

N/A

@dmohns dmohns added the bug Something isn't working label Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant