Skip to content

Add CONTRIBUTING.md and Update README Reference#87

Closed
Aditya30ag wants to merge 3 commits intonumfocus:mainfrom
Aditya30ag:docs/add-contributing-guidelines
Closed

Add CONTRIBUTING.md and Update README Reference#87
Aditya30ag wants to merge 3 commits intonumfocus:mainfrom
Aditya30ag:docs/add-contributing-guidelines

Conversation

@Aditya30ag
Copy link
Copy Markdown
Contributor

This PR introduces a dedicated CONTRIBUTING.md file containing detailed contribution guidelines and updates the README.md to reference the new file.

Changes Made

  • Created a new CONTRIBUTING.md file that includes:

    • Getting started steps
    • Types of contributions
    • Contributor guidelines
    • Review process
    • Contact/help information
  • Updated README.md

    • Added a clean reference link to CONTRIBUTING.md

Purpose

Separating contribution guidelines into a dedicated file improves readability, maintainability, and provides a standardized onboarding experience for new contributors.

@nabobalis
Copy link
Copy Markdown
Member

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?

@Aditya30ag
Copy link
Copy Markdown
Contributor Author

Hello @nabobalis
I did use an LLM to help draft portions of the contribution.md content.
new contributors the guidelines should also know where to start from (ex: clone and pre commit) in particular, this project requires running the pre-commit command before making a pr. If contributors skip this step, the build fails.

@nabobalis
Copy link
Copy Markdown
Member

Hello @nabobalis I did use an LLM to help draft portions of the contribution.md content. new contributors the guidelines should also know where to start from (ex: clone and pre commit) in particular, this project requires running the pre-commit command before making a pr. If contributors skip this step, the build fails.

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.

@Aditya30ag
Copy link
Copy Markdown
Contributor Author

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.

@nabobalis
Copy link
Copy Markdown
Member

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.

@Aditya30ag
Copy link
Copy Markdown
Contributor Author

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.
For now, I will go ahead and close this PR.

@Aditya30ag Aditya30ag closed this Feb 6, 2026
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