Skip to content

Commit f5d80f1

Browse files
committed
Merge branch 'main' into add-disableOnNumbers-to-typo-tolerance-settings
2 parents 718994e + f90e26e commit f5d80f1

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,24 @@
22

33
First of all, thank you for contributing to Meilisearch! The goal of this document is to provide everything you need to know in order to contribute to Meilisearch and its different integrations.
44

5+
- [Coding with AI](#coding-with-ai)
56
- [Assumptions](#assumptions)
67
- [How to Contribute](#how-to-contribute)
78
- [Development Workflow](#development-workflow)
89
- [Git Guidelines](#git-guidelines)
910
- [Release Process (for internal team only)](#release-process-for-internal-team-only)
1011

12+
## Coding with AI
13+
14+
We accept the use of AI-powered tools (GitHub Copilot, ChatGPT, Claude, Cursor, etc.) for contributions, whether for code, tests, or documentation.
15+
16+
⚠️ However, transparency is required: if you use AI assistance, please mention it in your PR description. This helps maintainers during code review and ensure the quality of contributions.
17+
18+
What we expect:
19+
- **Disclose AI usage**: A simple note like "Used GitHub Copilot for autocompletion" or "Generated initial test structure with ChatGPT" is sufficient.
20+
- **Specify the scope**: Indicate which parts of your contribution involved AI assistance.
21+
- **Review AI-generated content**: Ensure you understand and have verified any AI-generated code before submitting.
22+
1123
## Assumptions
1224

1325
1. **You're familiar with [GitHub](https://github.com) and the [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)(PR) workflow.**
@@ -20,7 +32,7 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume
2032
2. Once done, [fork the meilisearch-dotnet repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) in your own GitHub account. Ask a maintainer if you want your issue to be checked before making a PR.
2133
3. [Create a new Git branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository).
2234
4. Review the [Development Workflow](#development-workflow) section that describes the steps to maintain the repository.
23-
5. Make the changes on your branch.
35+
5. Make your changes on your branch. If you use AI tools during your work, remember to disclose it in your PR description (see [Coding with AI](#coding-with-ai)).
2436
6. [Submit the branch as a PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) pointing to the `main` branch of the main meilisearch-dotnet repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer.<br>
2537
We do not enforce a naming convention for the PRs, but **please use something descriptive of your changes**, having in mind that the title of your PR will be automatically added to the next [release changelog](https://github.com/meilisearch/meilisearch-dotnet/releases/).
2638

0 commit comments

Comments
 (0)