This repository contains specifications for proposed changes to the Glasgow Haskell Compiler. The purpose of the GHC proposal process and of the GHC Steering Committee is to broaden the discussion of the evolution of GHC.
A GHC Proposal is a document describing a proposed change to the compiler, the specification of the language it accepts, or the surrounding ecosystem. These include:
ShortImports proposals, do expressions without $)-Wall behavior)-XTypeInType, GHCi commands, type-indexed Typeable representations)Changes that are not necessarily within the scope of the committee include:
base, which should be addressed to the Core Libraries Committee;Should the GHC maintainers deem a change significant or controversial enough, they may, at their discretion, involve the GHC Steering Committee and ask the contributor to write a formal proposal.
Proposals are evaluated against our principles, which cover both language design and language stability
The life cycle of a proposalThis section outlines what stages a proposal may go through. The stage is identified by a GitHub label, which is identified in the following list.
(No label.) The author drafts a proposal.
(No label.) The author submits the proposal to the wider Haskell community for discussion, as a pull request against this repository.
(No label.) Responsibility for next action: author.
The wider community discusses the proposal in the commit section of the pull request, while the author refines the proposal. This phase lasts as long as necessary.
At some point the proposal author brings the proposal before the committee for review, which will prompt the committee secretary to appoint a shepherd for the proposal.
(No label.) Responsibility for next action: committee secretary. Timescale: a few days.
The committee secretary appoints a committee member as shepherd, which moves the proposal to the Pending shepherd recommendation state.
Label: Pending shepherd recommendation. Responsibility for next action: shepherd. Timescale: two weeks.
The shepherd reviews the proposal, and may request changes that they would like to see before they submit their recommendation to accept or reject the proposal to the committee.
During this period, the shepherd may change the label to "Needs revision". This does not imply that the shepherd is opposed to the proposal, but is merely meant to indicate that there are outstanding comments the author of the proposal needs to address before the shepherd can continue.
Within two weeks, the shepherd should submit their recommendation to accept or reject the proposal to the committee. This moves the proposal to the Pending committee review state.
Label: Pending committee review. Responsibility for next action: shepherd. Timescale: four or five weeks.
The shepherd actively guides the committee towards a consensus.
Within four or five weeks the committee should come to a conclusion, which may be:
Needs-revision is a common outcome, including for proposals that the committee is enthusiastic about. It is usually accompanied with guidance about the revisions that are sought. There may be multiple iterations of revision followed by committee discussion. The goal is to be clear about where the next action lies: with the committee or with the author.
Acceptance of the proposal implies that the implementation will be accepted into GHC provided it is well-engineered, well-documented, conforms to the specification and does not complicate the code-base too much. However, the GHC maintainers may reject an implementation if there turn out to be significant gaps in the specification, unforeseen interactions with existing features, or unexpected breaking changes not covered by the backwards compatibility assessment. In this case the proposal should be revised.
Label: Dormant. If a proposal sees no activity for along time, it is marked as “dormant”, and eventually closed.
Label: Implemented. Once a proposal is accepted, it still has to be implemented. The author may do that, or someone else. We mark the proposal as “implemented” once it hits GHC’s master branch (and we are happy to be nudged to do so by email, GitHub issue, or a comment on the relevant pull request).
Do not hesitate to contact us if you have questions.
How to start a new proposalProposals are written in either ReStructuredText or Markdown. While the proposal process itself has no preference, keep in mind that the GHC Users Guide uses ReStructuredText exclusively. Accepted proposals written in ReStructuredText thus have the slight benefit that they can be more easily included in the official GHC documentation.
Proposals should follow the structure given in the ReStructuredText template, or the Markdown template. (The two are identical except for format.)
See the section Review criteria below for more information about what makes a strong proposal, and how it will be reviewed.
To start a proposal, create a pull request that adds your proposal as proposals/0000-proposal-name.rst or proposals/0000-proposal-name.md. Use the corresponding proposals/0000-template file as a template.
The pull request summary should include a brief description of your proposal, along with a link to the rendered view of proposal document in your branch. For instance,
This is a proposal augmenting our existing `Typeable` mechanism with a variant, `Type.Reflection`, which provides a more strongly typed variant as originally described in [A Reflection on Types](http://research.microsoft.com/en-us/um/people/simonpj/papers/haskell-dynamic/index.htm) (Peyton Jones, _et al._ 2016). [Rendered](https://github.com/bgamari/ghc-proposals/blob/typeable/proposals/0000-type-indexed-typeable.rst)How to amend an accepted proposal
Some proposals amend an existing proposal. Such an amendment :
Often, this happens after a proposal is accepted, but before or while it is implemented. In these cases, a PR that _changes_ the accepted proposal can be opened. It goes through the same process as an original proposal.
Members of the Haskell community are warmly invited to offer feedback on proposals. Feedback ensures that a variety of perspectives are heard, that alternative designs are considered, and that all of the pros and cons of a design are uncovered. We particularly encourage the following types of feedback,
To comment on a proposal you need to be viewing the proposal's diff in "source diff" view. To switch to this view use the buttons on the top-right corner of the Files Changed tab.
Use the view selector buttons on the top right corner of the "Files Changed" tab to change between "source diff" and "rich diff" views.
Feedback on a open pull requests can be offered using both GitHub's in-line and pull request commenting features. Inline comments can be added by hovering over a line of the diff.
Hover over a line in the source diff view of a pull request and click on the + to leave an inline comment
For the maintenance of general sanity, try to avoid leaving "me too" comments. If you would like to register your approval or disapproval of a particular comment or proposal, feel free to use GitHub's "Reactions" feature.
How to bring a proposal before the committeeWhen the discussion has ebbed down and the author thinks the proposal is ready, they
The secretary will then label the pull request with Pending shepherd recommendation and start the committee process. (If this does not happen within a few days, please ping the secretary or the committee.)
In order to keep better track of actively discussed proposals, proposals that see no activity for an extended period of time (a month or two) might be marked as “dormant”. At any time the proposer, or someone else can revive the proposal by picking up the discussion (and possibly asking the secretary to remove the Dormant tag).
You can see the list of dormant proposals.
You can reach the committee by email at ghc-steering-committee@haskell.org. This is a mailing list with public archives.
The current members, including their GitHub handle, when they joined first, when their term last renewed, when their term expires and their role, are:
The committee members have committed to adhere to the Haskell committee guidelines for respectful communication and are subject to the committee bylaws.
We would also like to thank our former members:
Committee process for responding to a proposalThe committee process starts once the secretary has been notified that a proposal is ready for decision.
The steps below have timescales attached, so that everyone shares the same expectations. But they are only reasonable expectations. The committee consists of volunteers with day jobs, who are reviewing proposals in their spare time. If they do not meet the timescales indicated below (e.g. they might be on holiday), a reasonable response is a polite ping/enquiry.
The secretary nominates a member of the committee, the shepherd, to oversee the discussion. The secretary
Pending shepherd recommendation,Based on the proposal text (but not the GitHub commentary), the shepherd decides whether the proposal ought to be accepted or rejected or returned for revision. The shepherd should do this within two weeks.
If the shepherd thinks the proposal ought to be rejected, they post their justifications on the GitHub thread, and invite the authors to respond with a rebuttal and/or refine the proposal. This continues until either
Now the shepherd proposes to accept or reject the proposal. To do so, they
Pending committee review,(under review) at the end. (This enables easy email filtering.)Discussion among the committee ensues, in two places
It is expected that every committee member express an opinion about every proposal under review. The most minimal way to do this is to "thumbs-up" the shepherd's recommendation on GitHub.
Ideally, the committee reaches consensus, as determined by the secretary or the shepherd. If consensus is elusive, then we vote, with the Simons retaining veto power.
This phase should conclude within a month.
For acceptance, a proposal must have at least some enthusiastic support from member(s) of the committee. The committee, fallible though its members may be, is the guardian of the language. If all of them are lukewarm about a change, there is a presumption that it should be rejected, or at least "parked". (See "evidence of utility" above, under "What a proposal should look like".)
A typical situation is that the committee, now that they have been asked to review the proposal in detail, unearths some substantive technical issues. This is absolutely fine -- it is what the review process is for!
If the technical debate is not rapidly resolved, the shepherd should return the proposal for revision. Further technical discussion can then take place, the author can incorporate that conclusions in the proposal itself, and re-submit it. Returning a proposal for revision is not a negative judgement; on the contrary it might connote "we absolutely love this proposal but we want it to be clear on these points".
In fact, this should happen if any substantive technical debate takes place. The goal of the committee review is to say yes/no to a proposal as it stands. If new issues come up, they should be resolved, incorporated in the proposal, and the revised proposal should then be re-submitted for timely yes/no decision. In this way, no proposal should languish in the committee review stage for long, and every proposal can be accepted as-is, rather than subject to a raft of ill-specified further modifications.
The author of the proposal may invite committee collaboration on clarifying technical points; conversely members of the committee may offer such help.
When a proposal is returned for revision, GitHub labels are updated accordingly and the (under review) suffix is removed from the title of the PR.
The decision is announced, by the shepherd or the secretary, on the GitHub thread and the mailing list.
Notwithstanding the return/resubmit cycle described above, it may be that the shepherd accepts a proposal subject to some specified minor changes to the proposal text. In that case the author should carry them out.
The secretary then tags the pull request accordingly, and either merges or closes it. In particular
If we say no: The pull request will be closed and labeled Rejected.
If the proposer wants to revise and try again, the new proposal should explicitly address the rejection comments.
In the case that the proposed change has already been implemented in GHC, it will be reverted.
If we say yes: The pull request will be merged and labeled Accepted. Its meta-data will be updated to include the acceptance date. A link to the accepted proposal is added to the top of the PR discussion, together with the sentence “The proposal has been accepted; the following discussion is mostly of historic interest.”.
At this point, the proposal process is technically complete. It is outside the purview of the committee to implement, oversee implementation, attract implementors, etc.
The proposal authors or other implementors are encouraged to update the proposal with the implementation status (i.e. ticket URL and the first version of GHC implementing it.)
Committee members should see the acceptance page for a checklist to be applied to accepted proposals and the steps necessary in order to mark a proposal as accepted.
Here are some characteristics that a good proposal should have.
It should follow our design principles. These principles cover both the language design and its stability over time.
It should be self-standing. Some proposals accumulate a long and interesting discussion thread, but in ten years' time all that will be gone (except for the most assiduous readers). Before acceptance, therefore, the proposal should be edited to reflect the fruits of that discussion, so that it can stand alone.
It should be precise, especially the "Proposed change specification" section. Language design is complicated, with lots of interactions. It is not enough to offer a few suggestive examples and hope that the reader can infer the rest. Vague proposals waste everyone's time; precision is highly valued.
We do not insist on a fully formal specification, with a machine-checked proof. There is no such baseline to work from, and it would set the bar far too high. On the other hand, for proposals involving syntactic changes, it is very reasonable to ask for a BNF for the changes. (Use the Haskell 2010 Report or GHC's alex- or happy-formatted files for the lexer or parser for a good starting point.)
Ultimately, the necessary degree of precision is a judgement that the committee must make; but authors should try hard to offer precision.
It should offer evidence of utility. Even the strongest proposals carry costs:
All these costs constitute a permanent tax on every future programmer, language designer, and GHC maintainer. The tax may well be worth it (a language without polymorphism would be simpler but we don't want it), but the case should be made.
The case is stronger if lots of people express support by giving a "thumbs-up" in GitHub. Even better is the community contributes new examples that illustrate how the proposal will be broadly useful. The committee is often faced with proposals that are reasonable, but where there is a suspicion that no one other than the author cares. Defusing this suspicion, by describing use-cases and inviting support from others, is helpful.
It should be copiously illustrated with examples, to aid understanding. However, these examples should not be the specification.
Below are some criteria that the committee and the supporting GHC community will generally use to evaluate a proposal. These criteria are guidelines and questions that the committee will consider. None of these criteria is an absolute bar: it is the committee's job to weigh them, and any other relevant considerations, appropriately.
Utility and user demand. What exactly is the problem that the feature solves? Is it an important problem, felt by many users, or is it very specialised? The whole point of a new feature is to be useful to people, so a good proposal will explain why this is so, and ideally offer evidence of some form. The "Endorsements" section of the proposal provides an opportunity for third parties to express their support for the proposal, and the reasons they would like to see it adopted.
Elegant and principled. Haskell is a beautiful and principled language. It is tempting to pile feature upon feature (and GHC Haskell has quite a bit of that), but we should constantly and consciously strive for simplicity and elegance.
This is not always easy. Sometimes an important problem has lots of solutions, none of which have that "aha" feeling of "this is the Right Way to solve this"; in that case we might delay rather than forge ahead regardless.
Does not create a language fork. By a "fork" we mean
The idea is that unless we can see a path to a point where everyone has the extension turned on, we're left with different groups of people using incompatible dialects of the language. A similar problem arises with extensions that are mutually incompatible.
Fit with the language. If we just throw things into GHC willy-nilly, it will become a large ball of incoherent and inconsistent mud. We strive to add features that are consistent with the rest of the language.
Specification cost. Does the benefit of the feature justify the extra complexity in the language specification? Does the new feature interact awkwardly with existing features, or does it enhance them? How easy is it for users to understand the new feature?
Implementation cost. How hard is it to implement?
Maintainability. Writing code is cheap; maintaining it is expensive. GHC is a very large piece of software, with a lifetime stretching over decades. It is tempting to think that if you propose a feature and offer a patch that implements it, then the implementation cost to GHC is zero and the patch should be accepted.
But in fact every new feature imposes a tax on future implementors, (a) to keep it working, and (b) to understand and manage its interactions with other new features. In the common case the original implementor of a feature moves on to other things after a few years, and this maintenance burden falls on others.
The proposals can be rendered by running:
nix-shell shell.nix --run "./build.sh"
This will then create a directory _build which will contain an index.html file and the other rendered proposals. This is useful when developing a proposal to ensure that your file is syntax correct.
To build without Nix, run:
./build.sh
To view the docs at http://127.0.0.1:8000 and rebuild on changes, add --autobuild.
Feel free to contact any of the members of the GHC Steering Committee with questions. Email and Matrix (#ghc:matrix.org) are both good ways of accomplishing this.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.3