Contributing Guidelines

Contributing to PromptSail

We believe in open community-driven software, and thanks to everyone who contributed. 🙏❤️

How Can I Contribute?

Improving the Documentation

We are always looking to improve our documentation. If you find any typos, errors, or have suggestions on how to improve the documentation, please feel free to open an issue or a pull request.

Add new examples

If you tested Prompt Sail with a new AI provider and you want to share your experience, please add a new example to the example directory. You shall aloso modify the LLM integration sections in the documentation.

Reporting Bugs

Ensure the bug was not already reported by searching on GitHub under Issues.
If you cannot find an open issue addressing the problem, open a new one.

Suggesting Enhancements and new features

Open a new issue with a clear view of what you have in mind, and add the label “idea”.

Your First Code Contribution

Go through the Developer Guide section and start with setup development environment
Get acquainted with how the repository is structured
Database schema is described in the section Database Schema
Want to improve the documentation? Check section How to write the documentation

The general forking procedure:

Fork the repo.
Create a new branch (git checkout -b feature-name).
Commit your changes (git commit -am 'Add some feature').
Push to the branch (git push origin feature-name).
Open a new Pull Request with a description what and why you have changed

Contributors

Thank you all 🙏