Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 2.1 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 2.1 KB
Raw

CONTRIBUTING.md

Contributing to interfAIce

First of all, thank you for considering contributing to interfAIce! We appreciate your time and effort and are excited to have you join our community. This document serves as a guideline for contributing to our open-source library.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork to your local machine.
  3. Set up your development environment, ensuring that all necessary dependencies are installed.
  4. Create a new branch for your feature or bugfix.

Code Style

We follow the Kotlin Coding Conventions for code style. Please make sure your code adheres to these conventions.

Additionally, before committing your code, ensure that the ktlintCheck passes:

./gradlew ktlintCheck

If there are any issues, you can try to fix them automatically by running:

./gradlew ktlintFormat

Tests

When contributing code to this repository, include a test for it in the same pull request (PR). Ensure that the specific test passes before submitting your PR:

./gradlew test

Also, make sure to provide the OPENAI_API_KEY environment variable to provide the tests with access to the OpenAI api

Pull Requests

  1. Commit your changes to your feature or bugfix branch.
  2. Push your branch to your fork on GitHub.
  3. Create a pull request from your fork's branch to the original repository's main branch.
  4. In the pull request description, provide a clear and concise description of the changes you made, and mention any issues that your PR addresses.
  5. Await feedback from maintainers. They may request changes or ask questions. Be prepared to iterate on your PR based on their feedback.

Code of Conduct

We expect all contributors to adhere to the standard Code of Conduct. Please treat everyone with respect and maintain a professional and inclusive environment.

Once again, thank you for your interest in contributing to interfAIce. We look forward to your contributions and to working with you!