Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
105 lines (69 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

105 lines (69 loc) · 2.61 KB

🐍 Contributing to Awesome Python Scripts

First off — thank you for taking the time to contribute! All types of contributions are encouraged and valued. Please read the relevant section before contributing. It helps maintainers and ensures a smooth experience for everyone. 🎉

Steps for Contribution

1. Fork this repository

Click the Fork button at the top-right of this page. This creates a copy of the repository under your own GitHub account.

2. Clone the forked repository

Click on the green “Code” button in your forked repo and copy the link shown. Then, open your terminal and run:

git clone <url_you_just_copied>

Move into the cloned project directory:

cd <your_directory>

Now, create a new branch for your changes:

git checkout -b <your_branch_name>

3. Make your changes

Edit or add files as needed. You can check which files you’ve modified using:

git status

4. Add your changes

Add all modified files to staging using:

git add .

5. Commit your changes

Commit them with a meaningful message:

git commit -m "feat: add new python script for file sorting"

Commit Message Conventions

Commit Type Description
feat New feature or functionality added
fix Bug fix
docs Documentation updates
test Adding or updating tests
chore Maintenance or refactoring
ci Build or CI configuration changes

Tips:

  • Use present tense (“add feature” not “added feature”).
  • Keep the first line short (≤ 50 chars).
  • Separate the summary and body with a blank line.

6. Push your changes

Push the branch to your GitHub fork:

git push --set-upstream origin <your_branch_name>

7. Create a Pull Request

  1. Go to your forked repo on GitHub.
  2. Click on Compare & pull request.
  3. Add a descriptive title and explain your changes.
  4. Click Create pull request.

Once submitted, the maintainers will review your PR and merge it if everything looks good. 🎉

Additional Notes

  • Please make sure your code is well-formatted and tested before submission.
  • If your contribution adds new scripts, include a short README section describing what the script does.
  • Be respectful and kind in discussions — we’re all here to learn and grow together ❤️

Thank you for contributing to Awesome Python Scripts! 🐍 Your efforts make this community better every day.