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

Clean Up Repository #52

Closed
not-nef opened this issue Jan 17, 2022 · 19 comments · Fixed by #57
Closed

Clean Up Repository #52

not-nef opened this issue Jan 17, 2022 · 19 comments · Fixed by #57
Assignees
Labels
enhancement New feature or request resolved This has been resolved

Comments

@not-nef
Copy link
Member

not-nef commented Jan 17, 2022

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 needed

  • Put all the requirements*.txt in a single dependencies folder (dont forget to update the docs)

  • Rename the docs folder to website, create a new folder called docs and put CODE_OF_CONDUCT.md, CONTRIBUTING.md, LICENSE, README.md in it

  • Maybe delete the Scripts folder? (idk what its used for)

@not-nef not-nef added the enhancement New feature or request label Jan 17, 2022
@im-coder-lg
Copy link
Member

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.

@im-coder-lg
Copy link
Member

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.

@not-nef
Copy link
Member Author

not-nef commented Jan 17, 2022

Nonono, you understood me wrong. We can keep the files seperate, just move them all in one folder

@sumeshir26
Copy link
Member

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

@im-coder-lg
Copy link
Member

I hate the GitHub UI. Makes it hard to locate new comments while on that page. They need to fix that.

@not-nef
Copy link
Member Author

not-nef commented Jan 17, 2022

No use moving repo data to docs.

Well, we would have 4 less files in the root dir

@im-coder-lg
Copy link
Member

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.

@not-nef
Copy link
Member Author

not-nef commented Jan 17, 2022

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

Proof

image

image

image

@im-coder-lg
Copy link
Member

Great, I'll edit this in the cleanup branch now.

@im-coder-lg
Copy link
Member

Also, don't get me wrong, I am putting a collapsor via HTML so that we could save some screen space.

@not-nef
Copy link
Member Author

not-nef commented Jan 17, 2022

No, because it is not python convention to put in in a folder

wut

@Futura-Py Futura-Py deleted a comment from not-nef Jan 17, 2022
@not-nef
Copy link
Member Author

not-nef commented Jan 17, 2022

Also, don't get me wrong, I am putting a collapsor via HTML so that we could save some screen space.

Epic

@im-coder-lg
Copy link
Member

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.

@im-coder-lg
Copy link
Member

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.

@sumeshir26
Copy link
Member

wut

If you see any big python repos, the requirements file is NEVER in a folder

@im-coder-lg
Copy link
Member

They just keep them in a file and make sure they use cross-platform modules.

@not-nef
Copy link
Member Author

not-nef commented Jan 17, 2022

wut

If you see any big python repos, the requirements file is NEVER in a folder

but we have 3 of them

@im-coder-lg
Copy link
Member

I think it's best to let them be.

@sumeshir26 sumeshir26 changed the title Clean Up Clean Up Repository Jan 18, 2022
@sumeshir26 sumeshir26 self-assigned this Jan 18, 2022
@im-coder-lg
Copy link
Member

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.

@im-coder-lg im-coder-lg self-assigned this Jan 18, 2022
@sumeshir26 sumeshir26 added resolved This has been resolved and removed triage-approved labels Jan 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request resolved This has been resolved
Development

Successfully merging a pull request may close this issue.

3 participants