Skip to content

Latest commit

 

History

History
34 lines (19 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

34 lines (19 loc) · 2.69 KB
Raw

Contributing to FoundationaLLM

We are happy to accept contributions to the FoundationaLLM project in the form of feedback, bug reports/feature requests, and pull requests. If you want to make code contributions, please be sure to branch from the head of the default branch.

Development approach

Are you interested in contributing to the code? We would love your help! However, we do have some guidelines that we need contributors to follow so that we can keep things running smoothly.

Please review the development approach document.

Submitting issues

Please keep in mind that the GitHub issue tracker is not meant as a general support forum but for reporting non-security bugs and feature requests. If you do find yourself in need of general support, please review support options and contact us through the FoundationaLLM website.

For security-related issues, please view our Security Policy.

When submitting an issue for a bug, please search to see if an issue already exists for the bug you encountered (FoundationaLLM/issues). If you find an existing issue that describes your bug, please comment and add any additional details you can offer, including relevant library versions and other useful environment details.

Do you have an idea for a feature or a general question about something not covered in the documentation, select one of the appropriate issue templates and provide as much detail as possible.

Reproducing issues

Point us to a minimalistic project that reproduces this issue (repro) hosted in a public GitHub repo.

We will close this issue if:

  • The repro project you share with us is complex. We can't investigate custom projects, so don't point us to such, please.
  • If we will not be able to repro the behavior you're reporting.
  • If the repro project is attached as a .zip file.
  • If the GitHub repro project is set to Private.

Submitting pull requests

Once you have made changes to your branch and want to submit a pull request, please make sure to follow the pull request template and provide as much detail as possible. You will notice various checkboxes. Please complete all of the checkboxes before submitting the pull request. This helps ensure high-quality pull requests.