Skip to content

Latest commit

 

History

History
88 lines (57 loc) · 4.87 KB

CONTRIBUTING.md

File metadata and controls

88 lines (57 loc) · 4.87 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

  • A reproducible test case or series of steps
  • The version of autogluon.cloud being used
  • Any modifications you've made relevant to the bug
  • Anything unusual about your environment or deployment

Ideally, you can install autogluon.cloud and its dependencies in a fresh virtualenv to reproduce the bug.

Contributing via Pull Requests

Code contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

  1. You are working against the latest source on the master branch.
  2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
  3. You open an issue to discuss any significant work - we would hate for your time to be wasted.

To send us a pull request, please:

  1. Fork the repository.
  2. Modify the source (see details below); please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
  3. Ensure local tests pass.
  4. Commit to your fork using clear commit messages.
  5. Send us a pull request, answering any default questions in the pull request interface.
  6. Notify the maintainer to review your PR so that they can tag your PR as safe to test and start the CI process.
  7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

GitHub provides additional document on forking a repository and creating a pull request.

Tips for Modifying the Source Code

  • Using a fresh virtualenv, install the package via pip3 install -e ..

  • Use Python versions consistent with what the package supports as defined in setup.py (3.8 - 3.11).

  • All code should adhere to the PEP8 style.

  • After you have edited the code, ensure your changes pass the unit tests via:

pytest test/
  • We encourage you to add your own unit tests, but please ensure they run quickly (unit tests involving cloud resources generally would take a long time). You can run a specific unit test within a specific file like this:
python3 -m pytest path_to_file::test_mytest

Or remove the ::test_mytest suffix to run all tests in the file:

python3 -m pytest path_to_file
  • After you open your pull request, our CI system will NOT run by default if you don't have write permission to our repo as our CI involves usage of AWS resources. Please ping the maintainer so that they can tag your PR and trigger the CI runs for you. Please check back and fix any errors encountered at this stage (you will need to repeat this process for each new commit you push).

Finding Contributions to Work On

Looking at the existing issues is a great way to find something to contribute on. As our project uses the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opensource-codeofconduct@amazon.com with any additional questions or comments.

Security Issue Notifications

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public github issue.

Licensing

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.

We may ask you to sign a Contributor License Agreement (CLA) for larger changes.