Skip to content
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

Add initial contributing to Mutmut documentation #355

Merged
merged 3 commits into from
Jan 12, 2025

Conversation

WillGibson
Copy link
Contributor

No description provided.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added to stop the following error when running pytest...

ImportError while importing test module '/Users/will/Dev/WillGibson/mutmut/tests/test_mutation.py'.
Hint: make sure your test modules/packages have valid Python names.

CONTRIBUTING.rst Outdated

.. code-block:: console

python <path_to_mutmut_codebase>/mutmut/__main__.py run
Copy link
Owner

Choose a reason for hiding this comment

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

I think it's more sane here to do python -m pip --editable . to install mutmut in the venv.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good shout. I didn't know about --editable. I have update this section.

@WillGibson
Copy link
Contributor Author

@boxed Is this one approvable now?

@boxed boxed merged commit 98b5f5c into boxed:main Jan 12, 2025
1 check passed
@WillGibson WillGibson deleted the initial-contributing-documentation branch January 13, 2025 01:18
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.

2 participants