Skip to content

Describe Definition of Done for the code changes #1642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sequba wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Describe Definition of Done for the code changes #1642

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e8aba2
Describe Definition of Done for the code changes
sequba Mar 24, 2026
0d7351f
Update DEV_DOCS.md
sequba Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions DEV_DOCS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,23 @@

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
- 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)
- 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:
Expand Down
Loading