Skip to content

Commit

Permalink
Update QUALITY_GUIDELINES.md
Browse files Browse the repository at this point in the history
  • Loading branch information
LorenzoBettini authored Apr 16, 2024
1 parent e0a9100 commit 94755ff
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion QUALITY_GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ This page lists criteria that code, commits, and pull requests should fulfill.
## API
1. We must not break binary backward compatibility of runtime artifacts. These are the artifacts an Xtext DSL user has installed. This does *not* include `xtext.generator` and test utilities.
2. If we introduce breaking changes without violating the first rule, the DSL developer should be guided as well as possible through the migration efforts. E.g., through comments on `@Deprecated` annotations or log messages.
3. We should be careful about what we make API because we will need to maintain it for a long time.
3. We should be careful about what we make API because we will need to maintain it for a long time. When we introduce a new accessible class or method, these must be annotated with `@since <major>.<minor>`, where `<major>.<minor>` is the current major and minor versions, respectively.

0 comments on commit 94755ff

Please sign in to comment.