Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
R
RIOT
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
cm-projects
RIOT
Commits
86bfcd89
Commit
86bfcd89
authored
6 years ago
by
danpetry
Browse files
Options
Downloads
Patches
Plain Diff
doc: Several changes for clarity
parent
beb2f0bf
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
MAINTAINING.md
+12
-9
12 additions, 9 deletions
MAINTAINING.md
with
12 additions
and
9 deletions
MAINTAINING.md
+
12
−
9
View file @
86bfcd89
...
@@ -36,12 +36,14 @@ the overall validity of the PR.
...
@@ -36,12 +36,14 @@ the overall validity of the PR.
Is the problem that the PR intends to solve clearly stated?
Is the problem that the PR intends to solve clearly stated?
2.
Is the solution presented in the PR as simple as possible to satisfy the
2.
Is the solution presented in the PR as simple as possible to satisfy the
requirements, but no simpler?
requirements, but no simpler?
3.
Is the PR functionally atomic? Does it address a single issue or should
3.
Is the PR a manageable size for you to handle? As a general rule of thumb,
it be split into multiple individual PRs?
if the PR is likely to take more than a full day for one person to review,
then it may need to be broken down, at your discretion.
4.
Is the solution well designed on a high level?
4.
Is the solution well designed on a high level?
5.
Do the concepts used by the PR make sense?
5.
Do the concepts used by the PR make sense?
6.
Does the PR break with existing concepts?
6.
Does the PR break with existing concepts?
7.
Is the structure of the PR itself valid?
7.
Is there a clean commit history in the pulled branch? The commit history
should show a clear breakdown of the work that has been done.
8.
Are there clear and adequate instructions on how to test the PR?
\
8.
Are there clear and adequate instructions on how to test the PR?
\
This may or may not include implemented tests as part of the PR.
This may or may not include implemented tests as part of the PR.
9.
Does the code compile and run?
9.
Does the code compile and run?
...
@@ -82,9 +84,9 @@ skipping some/all tests.
...
@@ -82,9 +84,9 @@ skipping some/all tests.
Check that the code follows the [Coding Conventions]. This can be aided (but not
Check that the code follows the [Coding Conventions]. This can be aided (but not
replaced) by Uncrustify, using the uncrustify-riot.cfg file found in the base
replaced) by Uncrustify, using the uncrustify-riot.cfg file found in the base
directory. Note the difference between personal coding style, which is
directory. Note the difference between personal coding style, which is
allowed
subjective and is allowed
subject to the other guidelines, and the coding
subject to the other guidelines, and the coding
conventions, which are absolute
conventions, which are absolute
and must always be followed.
and must always be followed.
### 5. - Review the documentation
### 5. - Review the documentation
...
@@ -105,7 +107,7 @@ complete that no input from the original developer or maintainer is required.
...
@@ -105,7 +107,7 @@ complete that no input from the original developer or maintainer is required.
-
Be responsive. Even if you are too busy to review the contribution, try to
-
Be responsive. Even if you are too busy to review the contribution, try to
add a note fairly soon after the PR is submitted, thanking them for their
add a note fairly soon after the PR is submitted, thanking them for their
awesom
e contribution and saying that you will review it in due course. Once
valuabl
e contribution and saying that you will review it in due course. Once
the contributor has made their changes, ensure you reply to them in a
the contributor has made their changes, ensure you reply to them in a
reasonable timeframe. Acknowledge their replies to concerns if you're happy
reasonable timeframe. Acknowledge their replies to concerns if you're happy
with their argument.
with their argument.
...
@@ -113,8 +115,9 @@ complete that no input from the original developer or maintainer is required.
...
@@ -113,8 +115,9 @@ complete that no input from the original developer or maintainer is required.
help the contributor. This can include code snippets, links to
help the contributor. This can include code snippets, links to
code/issues/wiki entries/web pages, or anything else. Educating contributors
code/issues/wiki entries/web pages, or anything else. Educating contributors
means we are investing in our community.
means we are investing in our community.
-
Be friendly. Be objective in your review, and of course, follow the
-
Be friendly. Respect the original author, bearing in mind that their coding
[Code of Conduct].
style or their design may be just as valid as the way you would have done
it. And of course, always follow the [Code of Conduct].
### Organisation of reviewing between maintainers
### Organisation of reviewing between maintainers
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment