Thank you for your interest in contributing to the talkdai/Dialog project! We appreciate your support and welcome all contributions, whether they are bug reports, feature suggestions, code improvements, documentation enhancements, or anything else that helps improve the project.
- Code of Conduct
- Getting Started
- How to Contribute
- Style Guides
- Community
- License
- Maintainer Merge Policy
Please read and adhere to our Code of Conduct to ensure a welcoming and friendly environment for everyone involved.
To start contributing, follow these steps:
- Fork the repository: Click the "Fork" button on the top right of the repository page.
- Clone your fork: Clone your forked repository to your local machine.
git clone https://github.com/your-username/dialog.git
- Create a new branch: Create a new branch for your work.
git checkout -b my-new-feature
- Set up the development environment: Follow the instructions in the README to set up the project on your local machine.
If you find a bug, please report it by opening an issue with the following information:
- A clear and descriptive title.
- Steps to reproduce the issue.
- Expected and actual behavior.
- Screenshots, if applicable.
- Any additional information that might help us diagnose the problem.
We are always looking to improve talkdai/Dialog! To suggest a new feature:
- Open an issue with a descriptive title.
- Explain why this feature would be useful.
- Describe the feature in detail.
- Include any relevant examples or mockups.
- Check existing issues: Look for existing issues that might cover your changes. If there isn't one, create a new issue to discuss the change.
- Fork and clone the repository: See Getting Started.
- Create a branch: Make your changes in a new branch.
- Write tests: Ensure that your changes are covered by tests.
- Commit your changes: Write clear and concise commit messages.
- Push your branch: Push your branch to your forked repository.
git push origin my-new-feature
- Create a Pull Request: Go to the original repository and create a pull request. Please provide a detailed description of your changes and link any related issues.
Good documentation helps others understand and use the project effectively. To contribute to documentation:
- Improve existing documentation in the
docs
folder. - Add new documentation for new features.
- Ensure examples are clear and helpful.
- Fix any typos or grammatical errors.
- Follow the existing code style and conventions.
- Use meaningful variable and function names.
- Keep your code clean and well-commented.
- Use clear, descriptive commit messages.
- Follow the format:
Short summary (max 50 characters)
followed by an optional detailed explanation.
- Write in clear, concise English.
- Use appropriate formatting for headings, lists, code blocks, etc.
- Provide examples where necessary.
Join the conversation and connect with other contributors:
- Follow us on Twitter.
- Join our Discord community.
- Subscribe to our newsletter for updates.
By contributing to talkdai/Dialog, you agree that your contributions will be licensed under the MIT License.
Maintainers play a crucial role in keeping the project moving forward. To streamline the process, maintainers have the discretion to merge a pull request without a review if it has been open for at least 3 days and has not received any reviews or comments. This helps ensure timely progress while still allowing ample opportunity for community feedback.
Thank you for contributing to talkdai/Dialog! Your support and contributions are invaluable in helping us build and improve this project. We look forward to collaborating with you!