Welcome to the smallrye-llm project! We welcome contributions from the community. This guide will walk you through the steps for getting started on our project.
Please refer to our Wiki for the Contribution Guidelines.
The smallrye-llm project uses GitHub to manage issues. All issues can be found here.
To create a new issue, comment on an existing issue, or assign an issue to yourself, you'll need to first create a GitHub account.
Want to contribute to the smallrye-llm project but aren't quite sure where to start? Check out our issues with the good first issue label. These are a triaged set of issues that are great for getting started on our project. These can be found here.
Once you have selected an issue you'd like to work on, make sure it's not already assigned to someone else, and assign it to yourself.
It is recommended that you use a separate branch for every issue you work on. To keep things straightforward and memorable, you can name each branch using the GitHub issue number. This way, you can have multiple PRs open for different issues. For example, if you were working on issue-125, you could use issue-125 as your branch name.
You will need:
- Python 3.12+
- Git
- An IDE (e.g., Apache NetBeans)
To setup your development environment you need to:
-
First
cdto the directory where you cloned the project (eg:cd smallrye-llm) -
To build
smallrye-llmrun:mvn clean install -
To run the tests:
``` mvn test ```
All submissions, including submissions by project members, need to be reviewed by at least one smallrye-llm committer before being merged.
The GitHub Pull Request Review Process is followed for every pull request.