Skip to content

Latest commit

 

History

History
84 lines (63 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

84 lines (63 loc) · 2.58 KB

Contributing to Easy Python Installer

Thank you for considering contributing to the Easy Python Installer! Contributions are what make this project better, and I’m excited to have you on board.

Getting Started

🛠 Requirements

Before you start contributing, ensure you have the following tools installed:

  • Git
  • A terminal (Bash, Zsh, or equivalent)

📦 Setting Up the Repository

  1. Fork the repository by clicking the Fork button at the top-right of the GitHub repo.
  2. Clone your forked repository: 
    git clone https://github.com/<your-username>/sh-python-installer.git
  3. Navigate to the project directory: 
    cd sh-python-installer
  4. Add the original repository as a remote: 
    git remote add upstream https://github.com/tvdsluijs/sh-python-installer.git

Contributing Guidelines

🚀 Adding Features or Fixes

  1. Create a new branch for your changes: 
    git checkout -b feature/your-feature-name
  2. Make your changes in the script or related files.
  3. Run tests to ensure your changes work as expected.
  4. Commit your changes with a meaningful message: 
    git commit -m "Add: Brief description of your feature or fix"
  5. Push your branch to your fork: 
    git push origin feature/your-feature-name

🧪 Testing Your Changes

Before submitting, ensure:

  • The script runs without errors.
  • Key functionalities (e.g., version validation, installation flow) work as intended.
  • You haven’t broken existing functionality.

🔄 Submitting Pull Requests

  1. Go to your forked repository on GitHub.
  2. Click on the New Pull Request button.
  3. Write a clear title and description of your changes.
  4. Submit your pull request!

Code of Conduct

Please note that this project adheres to the Code of Conduct. By participating, you agree to uphold a respectful and collaborative environment.

Support & Feedback

Have questions or need help with your contribution? Feel free to:

⭐️ Thank You!

Every contribution, no matter how small, makes a difference. Whether it’s fixing a typo, improving documentation, or adding a feature, I appreciate your effort. Don’t forget to star the repo on GitHub if you haven’t already!

Let’s make this project better together! 🚀