Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
postmarketOS Change Requests
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
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
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
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
postmarketOS
postmarketOS Change Requests
Commits
ac75830e
Commit
ac75830e
authored
2 months ago
by
Casey
Browse files
Options
Downloads
Patches
Plain Diff
treewide: actually pass markdownlint
Signed-off-by:
Caleb Connolly
<
caleb@postmarketos.org
>
parent
3da43df1
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Pipeline
#215945
passed
2 months ago
Stage: test
Changes
3
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
0000-template.md
+2
-1
2 additions, 1 deletion
0000-template.md
0001-pmcr-process.md
+4
-3
4 additions, 3 deletions
0001-pmcr-process.md
README.md
+51
-51
51 additions, 51 deletions
README.md
with
57 additions
and
55 deletions
0000-template.md
+
2
−
1
View file @
ac75830e
# REPLACE-ME: Title
*
Date proposed: yyyy-mm-dd
*
PMCR ID: https://gitlab.postmarketos.org/postmarketOS/pmcr/-/merge_requests/ID
*
PMCR ID:
<https://gitlab.postmarketos.org/postmarketOS/pmcr/-/merge_requests/ID>
**update this number after PMCR merge request has been filed!**
## Summary
...
...
This diff is collapsed.
Click to expand it.
0001-pmcr-process.md
+
4
−
3
View file @
ac75830e
# Establish a Change Request process
*
Date proposed: 2024-11-21
*
PMCR ID: https://gitlab.postmarketos.org/postmarketOS/pmcr/-/merge_requests/1
*
PMCR ID:
<https://gitlab.postmarketos.org/postmarketOS/pmcr/-/merge_requests/1>
## Summary
Big changes to postmarketOS should not only be posted in an issue in
https://gitlab.postmarketos.org/postmarketOS/postmarketOS, but actually follow
a
process that encourages the people proposing it to think about a plan and the
<
https://gitlab.postmarketos.org/postmarketOS/postmarketOS
>
, but actually follow
a
process that encourages the people proposing it to think about a plan and the
consequences of the change.
## Motivation
...
...
This diff is collapsed.
Click to expand it.
README.md
+
51
−
51
View file @
ac75830e
postmarketOS Change Request (PMCR)
==================================
# postmarketOS Change Request (PMCR)
A postmarketOS Change Request (PMCR) is an
[
RFC
](
https://en.wikipedia.org/wiki/Request_for_Comments
)
process for
...
...
@@ -7,14 +6,14 @@ postmarketOS contributors to propose, design and discuss new features and
changes in project direction in a focused environment.
PMCRs start as merge requests in:
https://gitlab.postmarketos.org/postmarketOS/pmcr/-/merge_requests
<
https://gitlab.postmarketos.org/postmarketOS/pmcr/-/merge_requests
>
## What does a PMCR do?
The PMCR process is intended to bring focus and structure to discussions of
important changes and new features. It provides a space for sharing and
collaborating on ideas and design documents, keeping community
discussion
organized and focused on the goal of reaching a decision.
collaborating on ideas and design documents, keeping community
discussion
organized and focused on the goal of reaching a decision.
Visibility and inclusivity are important values for PMCRs. They are advertised
in our monthly blog posts, and are followed by the team.
...
...
@@ -26,8 +25,8 @@ idea.
## When should I file a PMCR?
If you have an idea for something and are unsure if it needs a PMCR, the best
way to find out is to just ask (e.g. by opening
[
an
issue
](
https://gitlab.postmarketos.org/postmarketOS/pmcr/-/issues/new
)
and
way to find out is to just ask (e.g. by opening
[
an
issue
](
https://gitlab.postmarketos.org/postmarketOS/pmcr/-/issues/new
)
and
filling out the "idea" template.
PMCRs are used for proposing "substantial" changes. The meaning of "substantial"
...
...
@@ -52,8 +51,8 @@ Most changes do *not* require a PMCR:
same SoC, even if requiring user action.
*
Changing supported kernels for some devices.
*
Massive rebuild of kernels or device packages in pmaports, due to a change in
features or policy. Such as adding new options to kconfigcheck, or changing
the
location of deviceinfo.
features or policy. Such as adding new options to kconfigcheck, or changing
the
location of deviceinfo.
*
Big pmbootstrap refactorings that are transparent to the developers.
## Who can file a PMCR?
...
...
@@ -63,11 +62,11 @@ Anyone can file a PMCR.
We encourage everybody that has big ideas for changes to postmarketOS to open
PMCRs. Even if you have not figured out all the details on how to fill a PMCR,
it is welcomed. PMCRs are specifically designed for feedback to be gathered, and
we expect changes to happen between proposal and approval. People interested
can
help you get a PMCR to the finish line. We will rather have some PMCRs
opened
and waiting for being developed, or politely closed due to requiring
more work,
than leave great ideas in the drawer because people not feeling
entitled to
propose changes.
we expect changes to happen between proposal and approval. People interested
can
help you get a PMCR to the finish line. We will rather have some PMCRs
opened
and waiting for being developed, or politely closed due to requiring
more work,
than leave great ideas in the drawer because people not feeling
entitled to
propose changes.
It might help you shorten the process if you have shared and discussed your idea
with more people. That can also help gauge early support for the feature and
...
...
@@ -78,10 +77,10 @@ requirement.
### Step 0: Check previously proposed PMCRs and issues
It might be that the idea has already been proposed in the form of an issue,
or
there is a previous PMCR that is being worked on or was closed. Give those
previous attempts a read. Contribute to them if they are being worked on,
or
take feedback with you if you are doing a new attempt.
It might be that the idea has already been proposed in the form of an issue,
or
there is a previous PMCR that is being worked on or was closed. Give those
previous attempts a read. Contribute to them if they are being worked on,
or
take feedback with you if you are doing a new attempt.
### Step 1: Prepare the PMCR
...
...
@@ -93,49 +92,50 @@ show it to them and integrate feedback.
### Step 2: File the PMCR
Once everything is ready, and you want to announce it and official feedback,
check the
[
list of
MRs
](
https://gitlab.postmarketos.org/postmarketOS/pmcr/-/merge_requests?scope=all&state=all
)
check the
[
list of
MRs
](
https://gitlab.postmarketos.org/postmarketOS/pmcr/-/merge_requests?scope=all&state=all
)
and get the last number in there. Move the
`0000-<my-proposal-title>.md`
to
`<last-mr-number-+1>-<my-proposal-title>.md`
. Create a new merge request! Ping
any community members that might be interested or have collaborated with you
in
the ellaboration of the PMCR. If the PMCR might have some remarkable impact,
any community members that might be interested or have collaborated with you
in
the ellaboration of the PMCR. If the PMCR might have some remarkable impact,
please also queue a comment to add it to the monthly blog posts, by commenting
on the
[
corresponding
issue
](
https://gitlab.postmarketos.org/postmarketOS/postmarketos.org/-/issues/?label_name%5B%5D=monthly-blog-post
)
.
on the
[
corresponding
issue
](
https://gitlab.postmarketos.org/postmarketOS/postmarketos.org/-/issues/?label_name%5B%5D=monthly-blog-post
)
.
## Discussing a PMCR
Discussion about the PMCR should happen in the PMCR merge request. Any
discussions
that happen outside it should be summarized or linked to by the
authors.
The PMCR will likely undergo numerous revisions in the discussion
process, and
some might take time for it gain traction. Often big changes
require some time
for people to make up their minds and nicely collaborate.
Discussion about the PMCR should happen in the PMCR merge request. Any
discussions
that happen outside it should be summarized or linked to by the
authors.
The PMCR will likely undergo numerous revisions in the discussion
process, and
some might take time for it gain traction. Often big changes
require some time
for people to make up their minds and nicely collaborate.
We encourage everybody taking part in the PMCR discussion process to work
towards
reaching a conclusion in a constructive manner. When you make a post to
the PMCR
thread, focus on the contents and implications of the PMCR only. While
disagreeing, please always keep in mind the examples of
[
positive
behavior
](
https://postmarketos.org/coc/#our-standards
)
in the Code of
Conduct,
and try to work towards them.
We encourage everybody taking part in the PMCR discussion process to work
towards
reaching a conclusion in a constructive manner. When you make a post to
the PMCR
thread, focus on the contents and implications of the PMCR only. While
disagreeing, please always keep in mind the examples of
[
positive
behavior
](
https://postmarketos.org/coc/#our-standards
)
in the Code of
Conduct,
and try to work towards them.
## Finalizing a PMCR
The author(s) or the postmarketOS team might come to the conclusion that the
PMCR
needs no more discussion. If the PMCR has no blocking issues, or those
are
deemed to be short-term resolvable, either the authors or any member of the
The author(s) or the postmarketOS team might come to the conclusion that the
PMCR
needs no more discussion. If the PMCR has no blocking issues, or those
are
deemed to be short-term resolvable, either the authors or any member of the
postmarketOS team may request a vote to take place.
At this point, and when the PMCR requires implementation, the PMCR must contain
a
draft implementation plan that can be translated into a high-level planning
At this point, and when the PMCR requires implementation, the PMCR must contain
a
draft implementation plan that can be translated into a high-level planning
issue. It is also necessary to have a person responsible for the implementation
towards the Core Contributors. This way there is some warranty that PMCRs will be
executed.
During
[
Core Contributors' Meetings
](
https://wiki.postmarketos.org/wiki/Core_Contributors_Meetings
)
,
the Core Contributors will vote on approving or rejecting the PMCR. There will
be one vote per contributor, and a majority of 60% is needed to either approve,
or reject the PMCR. Decisions need a quorum of more than half of the members. If
there is a tie, it might be indicative that the PMCR requires further discussion,
and should be sent back to the author(s) to iterate based on feedback. The
results and reasoning will be published on a comment in the Merge Request.
towards the Core Contributors. This way there is some warranty that PMCRs will
be executed.
During
[
Core Contributors'
Meetings
](
https://wiki.postmarketos.org/wiki/Core_Contributors_Meetings
)
, the
Core Contributors will vote on approving or rejecting the PMCR. There will be
one vote per contributor, and a majority of 60% is needed to either approve, or
reject the PMCR. Decisions need a quorum of more than half of the members. If
there is a tie, it might be indicative that the PMCR requires further
discussion, and should be sent back to the author(s) to iterate based on
feedback. The results and reasoning will be published on a comment in the Merge
Request.
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