Skip to content

Commit 6d04f2c

Browse files
Updated Change Request guide (#8201)
* backlog * backlog * backlog
1 parent e56efb2 commit 6d04f2c

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

docs/contributing/requesting-a-change.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@ implementation.
2020

2121
[issue tracker]: https://github.com/squidfunk/mkdocs-material/issues
2222

23+
!!! warning "[How we manage change requests]"
24+
25+
Before submitting a new idea, please take a moment to read how we manage
26+
change requests
27+
28+
29+
[How we manage change requests]: #how-we-manage-change-requests
30+
2331
## Before creating an issue
2432

2533
Before you invest your time to fill out and submit a change request, we kindly
@@ -210,6 +218,39 @@ __We'll take it from here.__
210218

211219
---
212220

221+
## How we manage change requests
222+
223+
Change requests are submitted as issues on our public [issue tracker]. Since
224+
they often propose new features or enhancements, we review and manage them
225+
differently than bug reports.
226+
227+
To maintain clarity and ensure that our roadmap remains focused and achievable,
228+
we've introduced a structured process and use a dedicated [backlog] to
229+
track and organize change requests, and how they fit into our roadmap.
230+
231+
[backlog]: https://github.com/users/squidfunk/projects/4/views/1
232+
233+
Here’s how we handle new change requests:
234+
235+
1. We read and review the request to understand the idea.
236+
2. We may leave comments to clarify intent or suggest alternatives.
237+
3. If the idea is out of scope, we will close the request and explain why.
238+
4. If the idea aligns with the project's vision, we'll categorize it as a change
239+
request, and add it to our [backlog].
240+
5. In either case, we close the request to keep the issue tracker clean and
241+
focused on open bugs.
242+
243+
> Note: While the issue may be closed, that doesn't mean it's forgotten –
244+
> change requests added to the project board remain part of our long-term
245+
> planning.
246+
247+
__Benefits of this approach:__
248+
- Users get a clearer and quicker overview of known issues and bugs, as change
249+
requests are managed separentely, giving a better idea how actively this project
250+
is maintained.
251+
- Related ideas are grouped in the backlog, allowing us to track progress more
252+
effectively, and to more easily see which change requests are related.
253+
213254
## Rejected requests
214255

215256
__Your change request got rejected? We're sorry for that.__ We understand it can

0 commit comments

Comments
 (0)