Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

42 lines (24 loc) · 1.9 KB

Contributing to aeris-apisdk-py

⚠ Important! ⚠

Do not provide API keys via GitHub, whether through issues, contributed code, or documentation.

Submitting Issues

Security Issues

Please see our security policy. If our security policy is missing, and you like creating excellent security policies, why not help us out?

Issues with Aeris APIs or Services

If you believe you have found an issue with Aeris APIs or services, please submit a service request through https://aeriscom.zendesk.com/hc/en-us/requests/new

Issues with aeris-apisdk-py

If you wish to report a bug report or enhancement, please ensure it was not already reported by searching under Issues.

Please include the following information with your bug reports:

  • Python version
  • operating system version
  • version of the aeris-apisdk-py installed (e.g., from pip3 list)
  • pip version (e.g., pip3 --version) or poetry version (e.g., poetry --version), as appropriate
  • steps to reproduce

If you need to provide the configuration file created by the aeriscli config command, please redact your API key(s), and consider redacting your account ID, email, and any device identifiers.

Submitting Pull Requests

Before submitting a pull request, please be sure it passes our functional tests and coding style tests.

The following only applies if the major version of aeris-apisdk-py is greater than zero (0):

This project uses semantic versioning. If your changes would break backwards compatibility, the major version number must be bumped for the next release. You can help ensure this by:

  • mentioning that your changes break backwards compatibility in your pull request,
  • running poetry version major as part of your changes, or
  • doing both of the above.