-
-
Notifications
You must be signed in to change notification settings - Fork 159
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
[Feature] Update and Refactor the Github and Doc #947
Conversation
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 |
many file are visibly not used but still here, like at the root : or in the bin : should I delete them ? |
can be deleted if empty |
sometimes they are not empty but just not used by the code, like the two test |
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. |
LGTM, Ready to merge? |
Yes if Everything is good for you :) |
I'm currently addressing issue #944, though it's still a work in progress. (do not merge for the moment)
Changes:
Feel free to review and provide updates to this branch. Thanks!