Bamboo Panda

✏️ Editing: CONTRIBUTING.md

<!---

This file serves as an entry point for GitHub's Contributing
Guidelines [1] only.

GitHub doesn't render rST very well, especially in respect to internal
hyperlink targets and cross-references [2]. People also tend to
confuse rST and Markdown syntax. Therefore, instead of keeping the
contents here (and including from rST documentation under doc/), link
to the Sphinx generated docs is provided below.

[1] https://github.com/blog/1184-contributing-guidelines
[2] http://docutils.sourceforge.net/docs/user/rst/quickref.html#hyperlink-targets

-->

# Certbot Contributing Guide

Hi! Welcome to the Certbot project. We look forward to collaborating with you.

If you're reporting a bug in Certbot, please make sure to include:
 - The version of Certbot you're running.
 - The operating system you're running it on.
 - The commands you ran.
 - What you expected to happen, and
 - What actually happened.

If you're a developer, we have some helpful information in our
[Developer's Guide](https://certbot.eff.org/docs/contributing.html) to get you
started. In particular, we recommend you read these sections

- [Finding issues to work on](https://certbot.eff.org/docs/contributing.html#find-issues-to-work-on)
 - [Coding style](https://certbot.eff.org/docs/contributing.html#coding-style)
 - [Submitting a pull request](https://certbot.eff.org/docs/contributing.html#submitting-a-pull-request)

# Specific instructions for Josepy

## Configure a development environment

1) Install Poetry: https://python-poetry.org/docs/#installation
2) Setup a Python virtual environment
```bash
$ poetry install -E docs
```
3) Activate the Python virtual environment
```bash
# (On Linux)
$ source .venv/bin/activate
# (On Windows Powershell)
$ .\.venv\Script\activate
```
4) Optionally set up [pre-commit](https://pre-commit.com/) which will cause
simple tests to be automatically run on your changes when you commit them
```bash
$ pre-commit install
```

## Run the tests and quality checks

1) Configure a development environment ([see above](#configure-a-development-environment))
2) Run the tests
```bash
$ tox
```
3) You can also run specific tests
```bash
$ tox -e py
```
You can get a listing of the available tests by running
```bash
$ tox -l
```

T	Name	Size
📁	..	-
📁	ConfigArgParse-1.7.5.dist-info	-
📁	OpenSSL	-
📁	PySocks-1.7.1-py3.9.egg-info	-
📁	__pycache__	-
📁	_distutils_hack	-
📁	acme	-
📁	acme-3.1.0.dist-info	-
📁	certbot	-
📁	certbot-3.1.0.dist-info	-
📁	chardet	-
📁	chardet-4.0.0.dist-info	-
📁	crit	-
📁	crit-4.2.dist-info	-
📁	dateutil	-
📁	distro-1.5.0-py3.9.egg-info	-
📁	dnf	-
📁	dnf-plugins	-
📁	dnfpluginscore	-
📁	dns	-
📁	dnspython-2.6.1-py3.9.egg-info	-
📁	firewall	-
📁	gi	-
📁	google	-
📁	html2text	-
📁	html2text-2020.1.16-py3.9.egg-info	-
📁	idna	-
📁	idna-2.10-py3.9.egg-info	-
📁	importlib_metadata	-
📁	importlib_metadata-4.12.0.dist-info	-
📁	isc	-
📁	josepy	-
📁	josepy-1.14.0.dist-info	-
📁	nftables	-
📁	nftables-0.1.dist-info	-
📁	packaging	-
📁	packaging-20.9.dist-info	-
📁	parsedatetime	-
📁	parsedatetime-2.6-py3.9.egg-info	-
📁	pip	-
📁	pip-21.3.1.dist-info	-
📁	pkg_resources	-
📁	ply	-
📁	ply-3.11-py3.9.egg-info	-
📁	procfs	-
📁	protobuf-3.14.0-py3.9.egg-info	-
📁	pyOpenSSL-21.0.0-py3.9.egg-info	-
📁	pyRFC3339-1.1.dist-info	-
📁	pycparser	-
📁	pycparser-2.20-py3.9.egg-info	-
📁	pycriu	-
📁	pycriu-4.2.dist-info	-
📁	pygtkcompat	-
📁	pyinotify-0.9.6-py3.9.egg-info	-
📁	pyparsing-2.4.7.dist-info	-
📁	pyrfc3339	-
📁	python_dateutil-2.9.0.post0.dist-info	-
📁	python_linux_procfs-0.7.4-py3.9.egg-info	-
📁	pytz	-
📁	pytz-2021.1-py3.9.egg-info	-
📁	pyudev	-
📁	pyudev-0.22.0-py3.9.egg-info	-
📁	requests	-
📁	requests-2.25.1.dist-info	-
📁	rhn	-
📁	sepolgen	-
📁	sepolicy	-
📁	sepolicy-3.6-py3.9.egg-info	-
📁	setuptools	-
📁	setuptools-53.0.0.dist-info	-
📁	six-1.15.0.dist-info	-
📁	tuned	-
📁	up2date_client	-
📁	urllib3	-
📁	urllib3-1.26.5-py3.9.egg-info	-
📁	zipp	-
📁	zipp-3.20.1.dist-info	-
📄	CHANGELOG.rst	3.51 KB
📄	CONTRIBUTING.md	2.20 KB
📄	_version.py	21.00 B
📄	configargparse.py	72.41 KB
📄	configobj-5.0.6-py3.9.egg-info	2.96 KB
📄	configobj.py	87.53 KB
📄	distro.py	42.61 KB
📄	distutils-precedence.pth	152.00 B
📄	hwdata.py	7.95 KB
📄	isc-2.0-py3.9.egg-info	267.00 B
📄	pciutils-2.3.7-py3.9.egg-info	242.00 B
📄	protobuf-3.14.0-py3.9-nspkg.pth	539.00 B
📄	pyinotify.py	86.92 KB
📄	pyparsing.py	266.96 KB
📄	seobject.py	110.20 KB
📄	six.py	33.48 KB
📄	socks.py	30.36 KB
📄	sockshandler.py	3.87 KB
📄	validate.py	46.13 KB