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

[Feature] Update and Refactor the Github and Doc #947

Conversation

S0ly
Copy link
Member

@S0ly S0ly commented Apr 30, 2024

I'm currently addressing issue #944, though it's still a work in progress. (do not merge for the moment)

Changes:

  • Added an empty code of conduct in the .github directory.
  • Moved the contributing.md file to the .github directory.
  • Moved building.md into a readme file next to the relevant Docker.

Feel free to review and provide updates to this branch. Thanks!

@S0ly S0ly marked this pull request as draft April 30, 2024 12:42
@S0ly
Copy link
Member Author

S0ly commented Apr 30, 2024

many of the files that I add are empty

the main readme of the project need to be modified, and the issue template and code of conduct need to be filled

@S0ly S0ly changed the title [Feature] update and refactor documentation [Feature] update and refactor documentation and GitHub Apr 30, 2024
@S0ly
Copy link
Member Author

S0ly commented May 3, 2024

many file are visibly not used but still here,

like at the root :
test.json (mentioned nowhere in the code)
composer (empty file) (mentioned nowhere in the code)

or in the bin :
test.sh (mentioned nowhere in the code)

should I delete them ?

@S0ly S0ly changed the title [Feature] update and refactor documentation and GitHub [Feature] Update and Refactor the Project Code May 3, 2024
@1day2die
Copy link
Collaborator

1day2die commented May 6, 2024

many file are visibly not used but still here,

like at the root : test.json (mentioned nowhere in the code) composer (empty file) (mentioned nowhere in the code)

or in the bin : test.sh (mentioned nowhere in the code)

should I delete them ?

can be deleted if empty

@S0ly
Copy link
Member Author

S0ly commented May 6, 2024

sometimes they are not empty but just not used by the code, like the two test

@S0ly
Copy link
Member Author

S0ly commented May 7, 2024

I've made significant updates to the GitHub, including thorough doc cleaning. However, for the changes to take full effect, we'll need 1Day2Die to update the GitHub configuration.

This pull request introduces a more user-friendly and informative main readme, aimed at guiding users effectively. Additionally, I've added new documents for contribution guidelines, a code of conduct, pull request template, and security policy and moved them all to .github folder.

Moreover, I've cleaned up unused files and fixed broken links, and documented the .gitignore, .gitatribute, and .env.example files for clarity.

While these changes represent a solid starting point for a clearer and updated GitHub presence, there may be further adjustments needed in the future.

@S0ly S0ly marked this pull request as ready for review May 7, 2024 08:27
@S0ly S0ly changed the title [Feature] Update and Refactor the Project Code [Feature] Update and Refactor the Github May 7, 2024
@S0ly S0ly changed the title [Feature] Update and Refactor the Github [Feature] Update and Refactor the Github and Doc May 7, 2024
@1day2die
Copy link
Collaborator

1day2die commented May 7, 2024

LGTM, Ready to merge?

@S0ly
Copy link
Member Author

S0ly commented May 7, 2024

Yes if Everything is good for you :)

@1day2die 1day2die merged commit 159ba02 into Ctrlpanel-gg:development May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants