|
Size: 2638
Comment: add exemple page.
|
Size: 2068
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 23: | Line 23: |
| #pragma section-numbers 2 | pragma section-numbers 2 |
| Line 25: | Line 25: |
| <<Include(A:dev)>> | <Include(A:dev)>> |
| Line 27: | Line 27: |
| = Feature Title = | Feature Title = |
| Line 29: | Line 29: |
| '''Status: Project''' | ''Status: Project''' |
| Line 31: | Line 31: |
| '''Main proponents: YourNameHere''' | ''Main proponents: YourNameHere''' |
| Line 33: | Line 33: |
| /!\ This is a speculative project and does not represent any firm decisions on future behavior. | !\ This is a speculative project and does not represent any firm decisions on future behavior. |
| Line 35: | Line 35: |
| Add a short summary of the idea here. | dd a short summary of the idea here. |
| Line 37: | Line 37: |
| == Goal == | = Goal == |
| Line 39: | Line 39: |
| Explain what kind of problem are triggering this idea, why it is worth solving and the big picture of how you'll solve it. | xplain what kind of problem are triggering this idea, why it is worth solving and the big picture of how you'll solve it. |
| Line 42: | Line 42: |
| == Detailed description == | = Detailed description == |
| Line 44: | Line 44: |
| All kind of stuff can go here, solution description / alternative solution etc | ll kind of stuff can go here, solution description / alternative solution etc |
| Line 46: | Line 46: |
| == Roadmap == | = Roadmap == |
| Line 48: | Line 48: |
| * (./) various * (./) step * {x} That * {x} need * {x} to * {x} be * {x} performed |
* (./) various * (./) step * {x} That * {x} need * {x} to * {x} be * {x} performed |
| Line 56: | Line 56: |
| == Roadmap == | = See Also == |
| Line 58: | Line 58: |
| * Gather history rewriting function into a core module and get commands to use it, * expose an API to build and submit a `plan`, * use this `plan` as the on disk representation for in progress operation, * have a UI for the user to edit a `plan` (this will eventually replace histedit), * expose UI to execute a `plan` step by step / have an option for commands to just schedule the `plan`, * add some "preview" capability to the plan. |
* pointer * to * related * page |
| Line 65: | Line 63: |
| == See Also == * pointer * to * related * page |
---- CategoryDeveloper CategoryNewFeatures |
Note:
This page is primarily intended for developers of Mercurial.
Writing Down Your Improvement Proposal On The Wiki
1. When to make an improvements proposal
We write down "Plan" wiki page to track discussion, progress and evolution of largish enhancement proposal to Mercurial. Not all proposal go through a "Plan" wiki page some just get directly sent as patches, get solved in a simple email thread or discussed on the bug tracker. Here is a small list of reason why one might want to create a wiki page for a project:
- it involves some complicated design (like a binary format) that will receive multiple revision,
- it requires multiples independent steps that will get done gradually over a long period of time,
- it creates large amount of debate that justify to keep track of various dimension of the problem space and there solutions,
- it is a long term project that is not going to be implemented shortly but which surface often enough that we want to keep track of various idea,
<insert your other good reason here>.
2. How to make improvements proposal
The title of the page should end with Plan
The page should have the CategoryNewFeatures and CategoryDeveloper (see DirstateFormatImprovementPlan for an example)
3. Example Source
pragma section-numbers 2
<Include(A:dev)>>
Feature Title =
''Status: Project'''
''Main proponents: YourNameHere'''
!\ This is a speculative project and does not represent any firm decisions on future behavior.
dd a short summary of the idea here.
= Goal ==
xplain what kind of problem are triggering this idea, why it is worth solving and the big picture of how you'll solve it.
= Detailed description ==
ll kind of stuff can go here, solution description / alternative solution etc
= Roadmap ==
* (./) various
* (./) step
* {x} That
* {x} need
* {x} to
* {x} be
* {x} performed
= See Also ==
* pointer
* to
* related
* page
----
CategoryDeveloper CategoryNewFeatures