Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
80 lines (54 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

80 lines (54 loc) · 2.47 KB

Contributing to mobile-use 🚀

Hey there, contributor! 🎉 First off, thank you for considering helping out with mobile-use. Every contribution, big or small, is incredibly valuable to us.

🏁 Getting Started

Ready to dive in? Here’s how you can get set up:

  1. Fork & Clone: Fork the repository and clone it to your local machine.
  2. Set Up Your Environment: Follow the "Manual Launch (Development Mode)" instructions in our README.md to get everything installed and ready to go.

💻 How to Contribute

Got an idea or a fix? Here’s the general workflow:

  1. Pick an Issue: A great place to start is our issues tab. Look for anything tagged good first issue!

  2. Create a Branch: Create a descriptive branch name for your feature or bug fix.

    git checkout -b your-awesome-feature

  3. Write Your Code: This is the fun part! Make your changes and improvements.

  4. Keep It Clean: Before you commit, make sure your code is formatted and linted correctly with Ruff.

    # Check for any linting errors
ruff check .

# Automatically format your code
ruff format .

  5. Run Tests: Make sure all the tests pass with pytest.

    pytest

  6. Commit Your Changes: Use clear and descriptive commit messages. We follow the Conventional Commits standard.

✨ Submitting a Pull Request

When your code is ready, open a Pull Request!

  • Push your branch to your fork.
  • Open a PR against the main branch of the original repository.
  • Make sure all the tests pass with pytest.
  • Provide a clear description of the changes you've made. We'll review it as soon as we can!

📦 Dependency Management with uv

We use uv to manage our dependencies. It's fast, and efficient.

Installing Dependencies

To get all the project dependencies installed from the lockfile, just run:

uv sync

This ensures your environment is perfectly aligned with ours.

Adding a New Package

Need to add a new package? Here’s how:

# For a production package
uv pip install <package-name>

# For a development-only package
uv pip install <package-name> --extra=dev

After installing, don't forget to update the lockfile and commit the changes:

uv lock
# git add uv.lock pyproject.toml && git commit ...

That's it! Thanks again for your contribution. We're excited to see what you build!