Skip to content

Commit 34e7e7e

Browse files
authored
Adds Contributing.md
1 parent fbb13af commit 34e7e7e

File tree

1 file changed

+114
-0
lines changed

1 file changed

+114
-0
lines changed

‎CONTRIBUTING.md‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# Contributing to talkd.ai/Dialog
2+
3+
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.
4+
5+
## Table of Contents
6+
7+
1. [Code of Conduct](#code-of-conduct)
8+
2. [Getting Started](#getting-started)
9+
3. [How to Contribute](#how-to-contribute)
10+
- [Reporting Bugs](#reporting-bugs)
11+
- [Suggesting Features](#suggesting-features)
12+
- [Contributing Code](#contributing-code)
13+
- [Improving Documentation](#improving-documentation)
14+
4. [Style Guides](#style-guides)
15+
5. [Community](#community)
16+
6. [License](#license)
17+
7. [Maintainer Merge Policy](#maintainer-merge-policy)
18+
19+
## Code of Conduct
20+
21+
Please read and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a welcoming and friendly environment for everyone involved.
22+
23+
## Getting Started
24+
25+
To start contributing, follow these steps:
26+
27+
1. **Fork the repository**: Click the "Fork" button on the top right of the repository page.
28+
2. **Clone your fork**: Clone your forked repository to your local machine.
29+
```sh
30+
git clone https://github.com/your-username/dialog.git
31+
```
32+
3. **Create a new branch**: Create a new branch for your work.
33+
```sh
34+
git checkout -b my-new-feature
35+
```
36+
4. **Set up the development environment**: Follow the instructions in the [README](README.md) to set up the project on your local machine.
37+
38+
## How to Contribute
39+
40+
### Reporting Bugs
41+
42+
If you find a bug, please report it by [opening an issue](https://github.com/talkdai/dialog/issues) with the following information:
43+
- A clear and descriptive title.
44+
- Steps to reproduce the issue.
45+
- Expected and actual behavior.
46+
- Screenshots, if applicable.
47+
- Any additional information that might help us diagnose the problem.
48+
49+
### Suggesting Features
50+
51+
We are always looking to improve talkdai/Dialog! To suggest a new feature:
52+
- [Open an issue](https://github.com/talkdai/dialog/issues) with a descriptive title.
53+
- Explain why this feature would be useful.
54+
- Describe the feature in detail.
55+
- Include any relevant examples or mockups.
56+
57+
### Contributing Code
58+
59+
1. **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.
60+
2. **Fork and clone the repository**: See [Getting Started](#getting-started).
61+
3. **Create a branch**: Make your changes in a new branch.
62+
4. **Write tests**: Ensure that your changes are covered by tests.
63+
5. **Commit your changes**: Write clear and concise commit messages.
64+
6. **Push your branch**: Push your branch to your forked repository.
65+
```sh
66+
git push origin my-new-feature
67+
```
68+
7. **Create a Pull Request**: Go to the original repository and [create a pull request](https://github.com/talkdai/dialog/pulls). Please provide a detailed description of your changes and link any related issues.
69+
70+
### Improving Documentation
71+
72+
Good documentation helps others understand and use the project effectively. To contribute to documentation:
73+
- Improve existing documentation in the `docs` folder.
74+
- Add new documentation for new features.
75+
- Ensure examples are clear and helpful.
76+
- Fix any typos or grammatical errors.
77+
78+
## Style Guides
79+
80+
### Code Style
81+
82+
- Follow the existing code style and conventions.
83+
- Use meaningful variable and function names.
84+
- Keep your code clean and well-commented.
85+
86+
### Commit Messages
87+
88+
- Use clear, descriptive commit messages.
89+
- Follow the format: `Short summary (max 50 characters)` followed by an optional detailed explanation.
90+
91+
### Documentation
92+
93+
- Write in clear, concise English.
94+
- Use appropriate formatting for headings, lists, code blocks, etc.
95+
- Provide examples where necessary.
96+
97+
## Community
98+
99+
Join the conversation and connect with other contributors:
100+
- Follow us on [Twitter](https://twitter.com/talkdai).
101+
- Join our [Discord](https://discord.gg/talkdai) community.
102+
- Subscribe to our [newsletter](https://talkdai.com/newsletter) for updates.
103+
104+
## License
105+
106+
By contributing to talkdai/Dialog, you agree that your contributions will be licensed under the [MIT License](LICENSE).
107+
108+
## Maintainer Merge Policy
109+
110+
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.
111+
112+
---
113+
114+
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!

0 commit comments

Comments
 (0)