[Git][ghc/ghc][master] haddock: Rework the contributing guide

[Marge Bot (@marge-bot)]

Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC


Commits:
ea2fe66e by Hécate Moonlight at 2024-05-22T00:36:13-04:00
haddock: Rework the contributing guide

- - - - -


2 changed files:

- − utils/haddock/CODE_OF_CONDUCT.md
- utils/haddock/CONTRIBUTING.md


Changes:

=====================================
utils/haddock/CODE_OF_CONDUCT.md deleted
=====================================
@@ -1,33 +0,0 @@
-# Conduct
-
-* We are committed to providing a friendly, safe and welcoming environment for all, regardless of level of experience,
-gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age,
-religion, nationality, or other similar characteristic.
-
-* Please avoid using overtly sexual aliases or other nicknames that might detract from a friendly, safe
-and welcoming environment for all.
-
-* Please be kind and courteous. There’s no need to be mean or rude.
-
-* Respect that people have differences of opinion and that every design or implementation choice carries a trade-off
-and numerous costs. There is seldom a right answer.
-
-* Please keep unstructured critique to a minimum. If you have solid ideas you want to experiment with,
-make a fork and see how it works.
-
-* We will exclude you from interaction if you insult, demean or harass anyone. That is not welcome behavior.
-We interpret the term “harassment” as including the definition in the [Citizen Code of Conduct][CCC];
-if you have any lack of clarity about what might be included in that concept, please read their definition.
-In particular, we don’t tolerate behavior that excludes people in socially marginalized groups.
-
-* Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or
-made uncomfortable by a community member, please contact one of the maintainers or any of the
-Core Team immediately. Whether you’re a regular contributor or a newcomer,
-we care about making this community a safe place for you and we’ve got your back.
-
-* Likewise any spamming, trolling, flaming, baiting or other attention-stealing behavior is not welcome.
-
-_Adapted from the [Rust Lang][Rust CoC]'s code of conduct_
-
-[CCC]: https://github.com/stumpsyn/policies/blob/master/citizen_code_of_conduct.md
-[Rust CoC]: https://www.rust-lang.org/policies/code-of-conduct


=====================================
utils/haddock/CONTRIBUTING.md
=====================================
@@ -3,10 +3,6 @@
 Thank you for contributing to Haddock! Here is the information you will need in
 order to make your contribution
 
-## Code of Conduct
-
-We need you to read, acknowledge, and abide by our [Code of Conduct][CoC].
-
 ## Reporting issues
 
 Please open a ticket if you get an unexpected behaviour from Haddock!  
@@ -23,56 +19,21 @@ Here is a list of things you should include in your ticket
 
 * Include any other info you think might be relevant (sandbox? unusual setup?).
 
-## Hacking
+### Building the binary
 
-To get started you'll need the latest GHC release installed.
+Please visit https://ghc.dev to build a stage1 compiler.
+Then, run the following command from the top-level:
 
-Clone the repository:
-
-```bash
-git clone https://github.com/haskell/haddock.git
-cd haddock
 ```
-
-### Git Branches
-
-If your patch consists of glue code and interface changes with GHC, please
-open a Pull Request targeting the `ghc-head` branch.
-
-Otherwise, for improvements to the documentation generator,
-please base your pull request on the current GHC version branch
-(`ghc-9.0` for instance). The PR will be forward-ported to `ghc-head`
-so that documentation built within GHC can benefit from it.
-
-### Building the packages
-
-#### Using `cabal`
-
-Requires cabal `>= 3.4` and GHC `== 9.4`:
-
-You can install the latest build of GHC via ghcup using this command:
-
-```bash
-ghcup install ghc -u "https://gitlab.haskell.org/ghc/ghc/-/jobs/artifacts/master/raw/ghc-x86_64-deb9-linux-integer-simple.tar.xz?job=validate-x86_64-linux-deb9-integer-simple" head
+$ ./hadrian/build -j --flavour=Quick --freeze1 _build/stage1/bin/haddock
 ```
 
-```bash
-cabal v2-build all --enable-tests
-cabal v2-test all
-```
+## Working with the codebase
 
-### Updating golden testsuite outputs
+The project provides a Makefile with rules to accompany you during development:
 
-If you've changed Haddock's output, you will probably need to accept the new
-output of Haddock's golden test suites (`html-test`, `latex-test`,
-`hoogle-test`, and `hypsrc-test`). This can be done by passing the `--accept`
-argument to these test suites. With a new enough version of `cabal-install`:
-
-```
-cabal v2-test html-test latex-test hoogle-test hypsrc-test \
-  --test-option='--accept'
-```
+* `make style` runs the code formatter. You need `fourmolu` 0.15.0.0 installed.
+* `make tags` run the generation of etags/ctags, to enable you to browse to definitions without HLS. You need `ghc-tags` 1.8 installed.
 
 
 [SSCCE]: http://sscce.org/
-[CoC]: ./CODE_OF_CONDUCT.md



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/ea2fe66eef60a85d1c89f62077e6de2fa65b60c7

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/ea2fe66eef60a85d1c89f62077e6de2fa65b60c7
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20240522/305cbf43/attachment-0001.html>