From 1e8aba2f51bd623f35594e49fe875913f9cecd4b Mon Sep 17 00:00:00 2001 From: Kuba Sekowski Date: Tue, 24 Mar 2026 12:42:48 +0100 Subject: [PATCH 1/2] Describe Definition of Done for the code changes --- DEV_DOCS.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/DEV_DOCS.md b/DEV_DOCS.md index 0197a804c0..21226e1e42 100644 --- a/DEV_DOCS.md +++ b/DEV_DOCS.md @@ -2,6 +2,20 @@ Random notes and things to know useful for maintainers and contributors. +## Definition of Done for the code changes + +Each change to the production code (bugfixes, new features, improvements) must include these elements. They must be present in the pull request BEFORE requesting the code review. + +- changes to the production code +- automatic tests + - for bugfixes: at least one test reproducing the bug + - for new features: a set of tests describing the feature specification precisely +- updates to documentation related to the change + - for breaking changes: a section in the migration guide +- technical documentation in the form of the jsdoc comments (high-level description of the concepts used in the more complex code fragments) +- changelog entry +- pull request description + ## Sources of the function translations HF supports internationalization and provides the localized function names for all built-in languages. When looking for the valid translations for the new functions, try these sources: From 0d7351fc67451c647f9db8d79d8079fcbd816728 Mon Sep 17 00:00:00 2001 From: Kuba Sekowski Date: Wed, 25 Mar 2026 13:44:28 +0100 Subject: [PATCH 2/2] Update DEV_DOCS.md --- DEV_DOCS.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/DEV_DOCS.md b/DEV_DOCS.md index 21226e1e42..3349b9e00f 100644 --- a/DEV_DOCS.md +++ b/DEV_DOCS.md @@ -7,9 +7,12 @@ Random notes and things to know useful for maintainers and contributors. Each change to the production code (bugfixes, new features, improvements) must include these elements. They must be present in the pull request BEFORE requesting the code review. - changes to the production code + - including changes to all supported language packs in `src/i18n/languages` directory (if applicable) - automatic tests - for bugfixes: at least one test reproducing the bug - for new features: a set of tests describing the feature specification precisely + - pull requests from external contributors should include tests in `tests/` directory (they will be moved to the private repository by the internal team) + - internal team adds tests directly to the private repository (through a separate pull request) - updates to documentation related to the change - for breaking changes: a section in the migration guide - technical documentation in the form of the jsdoc comments (high-level description of the concepts used in the more complex code fragments)