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]: Better Readme and Github #944

Closed
S0ly opened this issue Apr 30, 2024 · 3 comments
Closed

[Bug]: Better Readme and Github #944

S0ly opened this issue Apr 30, 2024 · 3 comments
Labels
Bug / Fix Something isn't working and may need a fix

Comments

@S0ly
Copy link
Member

S0ly commented Apr 30, 2024

What is your request about?

Updating the Github and Readme

Branch

main

Solution idea

it would be nice to have a more complete readme whit links not broken because for exemple the contribution and demo link is broken, no code of conduct, the gitignore could be clearer

just have the GitHub updated, deactivate the part not needed like actions, package it can be done easily

I can do a pull request :D

Controlpanel Logs

No response

Additional Info

No response

@S0ly S0ly added the Bug / Fix Something isn't working and may need a fix label Apr 30, 2024
@1day2die
Copy link
Collaborator

i will adress this soon, true

@S0ly
Copy link
Member Author

S0ly commented Apr 30, 2024

@1day2die, I've noticed several issues:

  • The .gitignore lacks documentation and clarity. There are also redundant .gitignore files that repeat the main one. It might be helpful to consolidate and provide options.
  • There's no code of conduct. Adding one and moving it to .github along with contribution guidelines would be beneficial. Ensure to link them in the main README.
  • Consider moving BUILDING.md to the development folder as part of pull request refactor: Docker #946 and linking it to the main README.

I have some time, if you want I can do a pull request

@S0ly
Copy link
Member Author

S0ly commented Apr 30, 2024

and there is an empty composer file at the root, and a test.json that is visibly unused in the code

and the section deployment of the GitHub seems outdated too whit a broken link

@S0ly S0ly closed this as completed May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug / Fix Something isn't working and may need a fix
Projects
None yet
Development

No branches or pull requests

2 participants