Closed not-nef closed 2 years ago
Nice idea, but I did try that. docs
seems a simpler idea than website
and we could add the same data of CODE_OF_CONDUCT.md, etc. in the documentation. I think the Scripts
folder is used to make a VENV on Windows.
No use moving repo data to docs
.
Putting all the requirements-*.txt
together would be hard since win10toast exists only on Windows. Some modules are unavailable on Linux and macOS and it'd be better to load the required modules.
Maybe let's make a cleanup
branch and clean up the entire code. I'll try reformatting the website using Prettier and try Jest(idk they call it code coverage, what's it used for?) and use black
and other Python code formatters to format the code neatly.
Nonono, you understood me wrong. We can keep the files seperate, just move them all in one folder
Remove the .vscode folder since it isnt needed
Yeah, will do
Put all the requirements*.txt in a single dependencies folder (dont forget to update the docs)
No, because it is not python convention to put in in a folder
Maybe delete the Scripts folder? (idk what its used for)
Yes, will do
I hate the GitHub UI. Makes it hard to locate new comments while on that page. They need to fix that.
No use moving repo data to
docs
.
Well, we would have 4 less files in the root dir
Well, we would have 4 less files in the root dir
Those files must be in the repo dir. Don't blame me, it's GitHub convention.
Well, we would have 4 less files in the root dir
Those files must be in the repo dir. Don't blame me, it's GitHub convention.
No, they don't
Great, I'll edit this in the cleanup
branch now.
Also, don't get me wrong, I am putting a collapsor via HTML so that we could save some screen space.
No, because it is not python convention to put in in a folder
wut
Also, don't get me wrong, I am putting a collapsor via HTML so that we could save some screen space.
Epic
Following conventions might give you a solid five-star rating since everything is organized. That's my motto. I like a neat workspace, it's a habit.
Moreover, the collapsor is literally this:
<details>
<summary>Short title</summary>
Start details after a space to format Markdown.
End with a space.
</details>
Done.
wut
If you see any big python repos, the requirements file is NEVER in a folder
They just keep them in a file and make sure they use cross-platform modules.
wut
If you see any big python repos, the requirements file is NEVER in a folder
but we have 3 of them
I think it's best to let them be.
I'm also helping here. Basically, I think cleaning up the repo would also include organizing the files, so I am also assigning this to myself.
The repository definitely needs some cleaning. Its just a big mess atm. A few things i suggest doing:
Remove the
.vscode
folder since it isnt neededPut all the
requirements*.txt
in a singledependencies
folder (dont forget to update the docs)Rename the
docs
folder towebsite
, create a new folder calleddocs
and putCODE_OF_CONDUCT.md
,CONTRIBUTING.md
,LICENSE
,README.md
in itMaybe delete the
Scripts
folder? (idk what its used for)