Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (28 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

33 lines (28 loc) · 1.21 KB
Raw

Contributing to ShadowMaker

Thank you for considering contributing to ShadowMaker! We welcome all contributions, whether you're fixing a bug, improving documentation, or adding new features.

Getting Started

  1. Fork the Repository: Start by forking the repository on GitHub. This creates your own copy of the project where you can make changes.

  2. Clone the Repository: Clone your fork to your local machine.

    git clone https://github.com/yourusername/shadowmaker.git
cd shadowmaker

  3. Create a Branch: It's recommended to create a new branch for your work.

    git checkout -b feature-or-bugfix-name

  4. Install Dependencies: Ensure you have all the dependencies installed.

    pip install -r requirements.txt

  5. Make Your Changes:. Make the necessary changes or improvements.

  6. Run Tests: Ensure all tests pass before submitting your changes.

  7. Commit Your Changes: Commit your changes with a meaningful commit message.

    git add .
git commit -m "Description of your changes"

  8. Push to GitHub: Push your changes to your GitHub repository.

        git push origin feature-or-bugfix-name