Skip to content

doc: contribution guidelines 📓 fixes issue #439 #441

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

Merged

Conversation

leftkats
Copy link
Contributor

@leftkats leftkats commented Jun 6, 2025

PR Title
Add CONTRIBUTING.md file with contribution guidelines for Python scripts

Summary
Added a clear and simple CONTRIBUTING.md file to help guide contributors on how to add Python scripts to the repository, including steps for discussion, contribution, PR creation, and a link to the code of conduct.

Description
The changes are as follows:

  • Added a new CONTRIBUTING.md file with contribution guidelines.
  • Included instructions for first-time contributors and a link to a helpful external resource.
  • Referenced the existing code of conduct to ensure a welcoming community environment.

Checks

In the repository

  • Made no changes that degrade the functioning of the repository
  • Gave each commit a better title (unlike generic "updated README.md")

In the PR

  • Followed the format of the pull_request_template
  • Made the Pull Request in a small level (for the creator’s welfare)
  • Tested the changes you made

Thank You,
leftkats

Resolves #439

@leftkats leftkats changed the title doc: add contribution guidelines doc: contribution guidelines 📓 Jun 6, 2025
Copy link
Owner

@DhanushNehru DhanushNehru left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make the file name in capital letters.

Also change all the places where CONTRIBUTIONS.md is mentioned. Also make sure to delete the old one.

@leftkats leftkats force-pushed the contribution-guideline/issue439 branch from 94a8f62 to 34545b3 Compare June 6, 2025 14:25
@DhanushNehru
Copy link
Owner

You can squash it to a single commit @leftkats

@leftkats leftkats force-pushed the contribution-guideline/issue439 branch from 34545b3 to 201b33b Compare June 6, 2025 14:26
@leftkats
Copy link
Contributor Author

leftkats commented Jun 6, 2025

squashed into a single commit @DhanushNehru feel free to merge, thank you !

@leftkats leftkats changed the title doc: contribution guidelines 📓 doc: contribution guidelines 📓 fixes issue #439 Jun 6, 2025
@DhanushNehru DhanushNehru merged commit 57f8b87 into DhanushNehru:master Jun 7, 2025
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.

Suggestion to add file CONTRIBUTING.md
2 participants