First off, thanks for taking the time to contribute! ❤️
All types of contributions are encouraged and valued. Read this page for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
Types of contributions:
About contributing:
- Your First Code Contribution
- Passing Checks on GitHub
- Styleguides
- Commit Messages
- Join The Project Team
- Legal Notices
Before you ask a question:
- Search the internet for answers first. You might find a solution to your problem on Stack Overflow, Reddit, or somewhere else.
- Search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.
- Read the Documentation.
If you can't find an answer:
We will then help you as best as we can.
It's likely that you're running into a bug that hasn't been filed yet. If that's the case, we'll help you file a bug report.
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check this section).
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
- Collect information about the bug:
- Stack trace (Traceback)
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
- Possibly your input and the output
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <>.
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
- Open an Issue. (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
- Provide the information you collected in the previous section.
Once it's filed:
- The project team will label the issue accordingly.
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as
needs-repro. Bugs with theneeds-reprotag will not be addressed until they are reproduced. - If the team is able to reproduce the issue, it will be marked
needs-fix, as well as possibly other tags (such ascritical), and the issue will be left to be implemented by someone.
Look through the GitHub issues for bugs. Anything tagged with bug and help wanted is open to whoever wants to implement a fix for it.
To run your tests with coverage analysis, you can use the following command:
$ coverage run -m pytest tests
This command executes your test suite while collecting code coverage information.
To view the coverage report, you can execute the following command:
$ coverage report
This command will provide a summary of the test coverage, indicating which parts of the codebase are covered by the tests and which areas might require additional testing.
The project is currently in its infancy, and we have a huge need for documentation:
- Anything tagged with documentation and help wanted is open to whoever wants to implement a fix for it.
- If you see the need for documentation in a part of the project that doesn't have an open issue, you can either:
- Open an issue
- Write whatever docs you think are needed and submit a pull request.
Enhancements include:
- Completely new features
- Minor improvements to existing functionality
- Make sure that you are using the latest version.
- Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
- Major new features should be in their own Python module (also known as a "file"). For example, if you decide to add the AI-powered ability to track dates of events within a transcript, that new feature should be in a new module possibly named
transcript_add_dates.py.
In addition to passing tests, all pull requests must be properly formatted. To do that, just run these two commands at the root of the project:
ruff check . --fix
ruff format .To run the non-LLM tests (fast), run at the project root:
pytest tests/code/*.pyTo run the tests with LLMs, run at the project root:
pytest tests/llms/*.pyEnhancement suggestions are tracked as GitHub issues.
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
- You may want to include screenshots and animated GIFs which help you demonstrate the steps or point out the part which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- Explain why this enhancement would be useful to most users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
We need help getting the word out about this project. Please consider helping out by doing one (or more) of the following:
- Star the project
- Post about it on social media (Mastodon, X, Reddit, Hacker News, etc.)
- Refer to this project in your project's readme
- Mention the project at local meetups
- Tell your friends/colleagues
- Write a blog post, tutorial, book, or scientific paper about it
- Do a talk or workshop about it
- Make a podcast about it
- Record a YouTube or Twitch video about it
Unsure where to begin contributing to the project? You can start by looking through any issues tagged "good first issue" and "help wanted".
TODO
TODO
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
This project and everyone participating in it is governed by the CONTRIBUTING.md Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to any of the project's core team members.
This guide is based on