Firstly, thank you for considering contributing to Agentok Studio! It's people like you that make the open-source community such a fantastic place to learn, inspire, and create. Any contributions you make are greatly appreciated.
Agentok Studio follows a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.
Before creating bug reports, please ensure the issue hasn't already been reported by searching through the existing issues.
If you're unable to find an open issue addressing the problem, feel free to open a new one. When you are creating a bug report, please include as many details as possible by filling out the provided template. The more information we have, the better we can understand and fix the issue.
If you have suggestions for how to improve Agentok Studio, we'd love to hear them! Just like with bug reports, please take a moment to check that an enhancement hasn't already been suggested or implemented. If it hasn't, you can go ahead and propose your idea by opening a new issue and using the enhancement template.
Unsure where to begin contributing to Agentok Studio? You can start by looking through 'beginner' and 'help-wanted' issues:
- Beginner issues - issues which should only require a few lines of code, and a test or two.
- Help wanted issues - issues which should be a bit more involved than 'beginner' issues.
Both lists are sorted by how recently they were created. If you decide to tackle an issue, leave a comment so that other contributors know it's being handled and can offer help if needed.
Please follow these steps to have your contribution considered by the maintainers:
- Fork the repository and create your branch from
main. - If you've added code that should be tested, add tests.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
You can join our Slack or Discord(COMMUNICATION_PLATFORM_LINK) to discuss the project with the maintainers and other contributors.
- Write clean code with appropriate comments and abide by the coding conventions set by the community.
- Test your code, and write new tests as needed to maintain a robust codebase.
- Include documentation with your changes. No change is too small to warrant a mention in the project's documentation.
- Pull requests need to reference the original issue being addressed. Please add a reference to the issue in the pull request description.
Before you start on your contribution, you'll need to set up your environment for development. See the README.md for instructions on getting started.
Staying up-to-date with what's happening in the Agentok Studio community is important. Come back periodically for the latest updates, discussions, and contribution opportunities.
Your contributions are publicly acknowledged in a CONTRIBUTORS.md file. Not only will you be able to see yourself there, but it also serves as a way for us to say Thank You to everyone who helps make Agentok Studio better!
Thank you for being a part of the project, and for considering contributing to the ongoing work of making Agentok Studio an even better tool for everyone.
FlowGen Team