Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a note for contributors installing fourmolu #10473

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

philderbeast
Copy link
Collaborator

Fixes #10472.

Template B: This PR does not modify behaviour or interface

E.g. the PR only touches documentation or tests, does refactorings, etc.

Include the following checklist in your PR:

  • Patches conform to the coding conventions.
  • Is this a PR that fixes CI? If so, it will need to be backported to older cabal release branches (ask maintainers for directions).

Copy link
Collaborator

@geekosaur geekosaur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Trying to be a bit more formal, and include a way to install with a specific ghc. (Some people involved with cabal don't trust --with-compiler, but I use it somewhat regularly.)

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
- Redundant "that".
- Use indefinite article.
- Assume ghc version installed via ghcup
- Use `--with-compiler` option
- Grammar, "its requirement"

Co-Authored-By: brandon s allbery kf8nh <allbery.b@gmail.com>
@philderbeast
Copy link
Collaborator Author

@geekosaur I've squashed your suggestions and moved the --with-compiler option to a tip.

> ```
> [!Tip]
> If you have multiple versions of GHC installed with `ghcup`, a series specific
Copy link
Collaborator

@ulysses4ever ulysses4ever Oct 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> If you have multiple versions of GHC installed with `ghcup`, a series specific
> If you have multiple versions of GHC installed with `ghcup`, a series-specific

Hyphens strike again...

CONTRIBUTING.md Outdated Show resolved Hide resolved
> installing it this way is:
>
> ```
> $ cabal install fourmolu-0.12.0.0 --overwrite-policy=always --ignore-project
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A different worry here is that people may have other versions of fourmolu installed, and may need them for other projects. Sadly, there is no good solution to this at present.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Note which GHC versions contributors can use for installing fourmolu
4 participants