Skip to content

Commit 46c917a

Browse files
committed
Fix typos and apply suggestions
1 parent d3a51ea commit 46c917a

File tree

3 files changed

+13
-11
lines changed

3 files changed

+13
-11
lines changed

sycl/ReleaseNotes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## New Features
44

5-
- Added suport for ... intel/llvm#pr
5+
- Added support for ... intel/llvm#pr
66

77
## Improvements
88

sycl/doc/developer/ContributeToDPCPP.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ to signify the component changed, e.g.: `[UR]`, `[CUDA]`, `[Doc]`.
3939

4040
## Release notes
4141

42-
You are encouraged (but it is not required) to record your change into
42+
You are encouraged to record your change into
4343
[release notes](../../ReleaseNotes.md) under "Release notes for an upcoming
4444
release" section.
4545

@@ -53,12 +53,12 @@ A change should be noted there when:
5353

5454
A change should **not** be noted there when:
5555

56-
- It has no functional and performance impact
56+
- It has no functional or performance impact
5757
- It is about our CI infrastructure, testing infrastructure, or tests
5858

5959
There are no strict guidelines on how to structure release notes, but for
60-
consistency it is better to follow the existing structure without disrupting it
61-
much. The structure we have been using so far is split by change type (i.e. new
60+
consistency it is better to follow the existing structure minimal changes. The
61+
structure we have been using so far is split by change type (i.e. new
6262
features and bug fixes) and then sub-split by component (i.e. compiler,
6363
runtime). Please use past tense when describing your change.
6464

sycl/doc/developer/WorkingOnAReleaseBranch.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
11
# Working on a release branch
22

3-
Release branch is defined as a branch whose name starts with `sycl-rel-` prefix.
3+
A "release branch" is defined as a branch whose name starts with `sycl-rel-`
4+
prefix.
45

56
Those branches are intended to indicate stable snapshots of our product so that
6-
our users don't need to guess which nightly build is good enough for our needs.
7+
our users don't need to guess which nightly build is good enough for their
8+
needs.
79

810
Therefore, those branches have higher quality requirements and as such have
911
different contribution rules intended to preserve their stability.
1012

11-
If you are not familiar with [general contribution guidelines][contributing] or
12-
[DPC++ specific contribution guidelines][contributing-to-dpcpp], please
13+
If you are not familiar with the [general contribution guidelines][contributing]
14+
or the [DPC++ specific contribution guidelines][contributing-to-dpcpp], please
1315
familiarize yourself with those documents first because they also apply to
1416
release branches.
1517

1618
## Extra rules for release branches
1719

1820
### Only cherry-picks are allowed
1921

20-
It is assumed, that everything you do on a release branch, should also be
22+
It is assumed that everything you do on a release branch should also be
2123
repeated on the default `sycl` branch to ensure that it is automatically
2224
included into future releases.
2325

@@ -31,7 +33,7 @@ and then backport it to a release branch.
3133

3234
### No new features are allowed
3335

34-
Features are generally more complicated then bug fixes and may require further
36+
Features are generally more complicated than bug fixes and may require further
3537
bug fixes as well. Considering that release branches are intended to be stable,
3638
no new features are allowed to be added there.
3739

0 commit comments

Comments
 (0)