CONTRIBUTION¶

Contribution Agreement¶

As a contributor, you represent that the code you submit is your original work or that of your employer (in which case you represent you have the right to bind your employer). By submitting code, you (and, if applicable, your employer) are licensing the submitted code to LinkedIn and the open source community subject to the BSD 2-Clause license.

Responsible Disclosure of Security Vulnerabilities¶

Do not file an issue on Github for security issues. Please review the guidelines for disclosure. Reports should be encrypted using PGP (public key) and sent to security@linkedin.com preferably with the title “Vulnerability in Github LinkedIn/smart-arg - <short summary>”.

Setup for Development¶

# # Uncomment the next a few lines to set up a virtual environment and install the packages as needed
# python3 -m venv .venv
# . .venv/bin/activate
# pip install -U setuptools pytest flake8 mypy

python3 setup.py develop

# Happily make changes
# ...

mypy
flake8 smart_arg.py
pytest

Tips for Getting Your Pull Request Accepted¶

Make sure all new features are tested and the tests pass.
Bug fixes must include a test case demonstrating the error that it fixes.
Open an issue first and seek advice for your change before submitting a pull request. Large features which have never been discussed are unlikely to be accepted. You have been warned.