You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -12,6 +13,17 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume
12
13
13
14
<!-- /MarkdownTOC -->
14
15
16
+
## Coding with AI
17
+
18
+
We accept the use of AI-powered tools (GitHub Copilot, ChatGPT, Claude, Cursor, etc.) for contributions, whether for code, tests, or documentation.
19
+
20
+
⚠️ 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.
21
+
22
+
What we expect:
23
+
-**Disclose AI usage**: A simple note like "Used GitHub Copilot for autocompletion" or "Generated initial test structure with ChatGPT" is sufficient.
24
+
-**Specify the scope**: Indicate which parts of your contribution involved AI assistance.
25
+
-**Review AI-generated content**: Ensure you understand and have verified any AI-generated code before submitting.
26
+
15
27
## Assumptions
16
28
17
29
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.**
@@ -24,7 +36,7 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume
24
36
2. Once done, [fork the meilisearch-ruby 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.
25
37
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).
26
38
4. Review the [Development Workflow](#development-workflow) section that describes the steps to maintain the repository.
27
-
5. Make the changes on your branch.
39
+
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)).
28
40
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-ruby 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>
29
41
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-ruby/releases/).
0 commit comments