Add CONTRIBUTING.md and Update README Reference#87
Add CONTRIBUTING.md and Update README Reference#87Aditya30ag wants to merge 3 commits intonumfocus:mainfrom
Conversation
|
Hello @Aditya30ag, thank you again for the pull request. Can you please tell me how much of this was creating using an LLM? Can you also provide to me a reason for needing a contribution guide beyond what is already in the readme? |
|
Hello @nabobalis |
Then if the pre-commit needs to pass, maybe that can go into the readme? I still need a justification for a whole new document. |
|
absolutely right that the pre-commit requirement could be added to the README. My reason is proposing a separate contributing.md file is more about long-term structure and maintainability. |
|
I don't see how this improves the maintainability, can you please explain that to me? The information in the document is incorrect in several places, so for me, I am leaning towards closing this pull request as it stands. |
|
You’re right, I understand your concerns I’ll spend more time reviewing and improving the content, so it aligns properly with the project’s current structure and requirements. |
This PR introduces a dedicated
CONTRIBUTING.mdfile containing detailed contribution guidelines and updates theREADME.mdto reference the new file.Changes Made
Created a new
CONTRIBUTING.mdfile that includes:Updated
README.mdCONTRIBUTING.mdPurpose
Separating contribution guidelines into a dedicated file improves readability, maintainability, and provides a standardized onboarding experience for new contributors.