Skip to content
Snippets Groups Projects
Unverified Commit ac52a3fc authored by Casey's avatar Casey :recycle:
Browse files

treewide: pass markdownlint


Format everything to be consistent.

Signed-off-by: default avatarCaleb Connolly <caleb@postmarketos.org>
parent 2588ed0a
No related branches found
No related tags found
No related merge requests found
Pipeline #215102 failed
......@@ -4,7 +4,7 @@ potentially finding collaborators to work on a merge request (the eventual
PMCR).
-->
# Idea:
# Idea
<!--
Add the title after the "Idea: "
-->
......
## REPLACE-ME: Title
# REPLACE-ME: Title
* Date proposed: yyyy-mm-dd
* PMCR ID: https://gitlab.postmarketos.org/postmarketOS/pmcr/-/merge_requests/ID
......@@ -11,8 +11,8 @@ extended
## Motivation
REPLACE-ME: Explain the rationale that has motivated the creation of this PMCR. If applies,
also provide use-cases.
REPLACE-ME: Explain the rationale that has motivated the creation of this PMCR.
If applies, also provide use-cases.
## Consequences
......@@ -34,8 +34,8 @@ Think about:
REPLACE-ME: After approval, executing most PMCRs will require of some
implementation. It could be a technical implementation, like the coding and
packaging work needed to get systemd into postmarketOS. But it could also be
things like documenting a new process on the website, or changing permissions
to certain users.
things like documenting a new process on the website, or changing permissions to
certain users.
REPLACE-ME: This section aims to make the proposer *think* about how the
proposal can be implemented. An example in the context of the gitlab migration:
......@@ -53,10 +53,9 @@ X?" repeteadly.
### The proposer
REPLACE-ME: Explain which is your role in this process. Are you just proposing
a well-developed idea, and looking for people interested in executing it? Are
you able to completely execute it yourself, or maybe instead act as project
manager?
REPLACE-ME: Explain which is your role in this process. Are you just proposing a
well-developed idea, and looking for people interested in executing it? Are you
able to completely execute it yourself, or maybe instead act as project manager?
If deemed appropriate, you might request funding from postmarketOS to execute
it. postmarketOS can either approve it, reject it, or work with you on a grant
......@@ -64,7 +63,7 @@ application for the implementation team.
### Blocking issues
Sometimes plans require further work. Either other PMCRs, or implementations
in other parts of the ecosystem, like Alpine.
Sometimes plans require further work. Either other PMCRs, or implementations in
other parts of the ecosystem, like Alpine.
If deemed appropriate, you might also request funding for this.
## Establish a Change Request process
# Establish a Change Request process
* Date proposed: 2024-11-21
* PMCR ID: https://gitlab.postmarketos.org/postmarketOS/pmcr/-/merge_requests/1
......@@ -6,19 +6,19 @@
## 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 consequences of the change.
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
We have bumped into the problem that big changes in postmarketOS sometimes
lack structure. Though there have been announcements for most of them, the
timeline and consequences have not always been clear, leading to breakage
for developers and users. There has also been sometimes problems with
transparency and communication of decisions on big changes. This PMCR process
aims to solve those issues by providing a structure for people to think about
such changes, and share them with others.
We have bumped into the problem that big changes in postmarketOS sometimes lack
structure. Though there have been announcements for most of them, the timeline
and consequences have not always been clear, leading to breakage for developers
and users. There has also been sometimes problems with transparency and
communication of decisions on big changes. This PMCR process aims to solve those
issues by providing a structure for people to think about such changes, and
share them with others.
## Consequences
......@@ -34,9 +34,9 @@ Establishing this PMCR can have the following advantages:
rationalize again and again. It will also help not having to fetch those
rationales from old blog posts.
* Allow people outside the postmarketOS team to propose breaking ideas that
might improve postmarketOS overall. Those people are currently oftentimes
left out of the decision-making process, or don't have a proper way to
express themselves.
might improve postmarketOS overall. Those people are currently oftentimes left
out of the decision-making process, or don't have a proper way to express
themselves.
* Ensure that we have a place to point to people that want big changes to be
incorporated.
......@@ -59,8 +59,8 @@ Unfortunately, any process has its disadvantages too:
Contributors. This should be done via gitlab approvals once all discussion
threads are resolved. As part of those discussion, a voting process is
established and documented in the README of the project.
3. Inform about the new PMCR process in the blog, amend documentation as
needed, and start using it!
3. Inform about the new PMCR process in the blog, amend documentation as needed,
and start using it!
### The proposer
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment