Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

24 lines (17 loc) · 2.51 KB

Contributing to Koel Labs - Server

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

These are the specific contributing guidelines for the server repository. This is for those interested in optimizing the way we run inference or the algorithms we use to provide feedback. Checkout our general contributing guidelines here.

Where to Start

  1. Read the README.md file to understand the purpose of this repository.
  2. Read the DEVELOPMENT.md file to understand how to set up your local development environment. Important design decisions will also be documented here.
  3. Read the Code of Conduct to understand expectations while contributing to this project and take a look at the FAQ if you have any questions.
  4. Read through the issues to understand the current development priorities.
  5. All contributions start with an issue to discuss the change. See how to file a bug report, suggest a new feature, or make your first code contribution.
    • Look for the issues tagged good first issue and help wanted for things to work on.
    • Make sure to check the existing issues before creating a new one.
  6. Maintainers with write access to the repository will assign willing contributors to issues they request. Once assigned, fork the repository and create a branch for your work.
  7. When you are ready, submit a pull request to the main branch. The pull request template contains a checklist to go through.

Point of Contact

If you have any questions, feel free to reach out to alex@koellabs.com or open an issue. Security vulnerabilities should be reported to info@koellabs.com.

Legal Boilerplate

By making contributions to the Koel Labs project, you agree to retain all rights, title and interest in and to your contributions and confirm that Koel Labs can use, modify, copy, and redistribute said contributions, under its choice of terms.