Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
Cabal
Manage
Activity
Members
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Analyze
Contributor analytics
CI/CD analytics
Repository analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Glasgow Haskell Compiler
Packages
Cabal
Commits
a7d28eec
Commit
a7d28eec
authored
1 year ago
by
Brandon S. Allbery
Committed by
Mikolaj
1 year ago
Browse files
Options
Downloads
Patches
Plain Diff
add `merge+no rebase`
and a few typos while reviewing
parent
03809b3e
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.md
+14
-9
14 additions, 9 deletions
CONTRIBUTING.md
with
14 additions
and
9 deletions
CONTRIBUTING.md
+
14
−
9
View file @
a7d28eec
...
...
@@ -38,20 +38,20 @@ cabal build cabal-tests # etc...
Running tests
-------------
**Using Git
h
ub Actions.**
**Using Git
H
ub Actions.**
If you are not in a hurry, the most convenient way to run tests on Cabal
is to make a branch on GitHub and then open a pull request; our
continuous integration service on Git
h
ub Actions builds and
continuous integration service on Git
H
ub Actions builds and
tests your code. Title your PR with WIP so we know that it does not need
code review.
Some tips for using Git
h
ub Actions effectively:
Some tips for using Git
H
ub Actions effectively:
*
Git
h
ub Actions builds take a long time. Use them when you are pretty
*
Git
H
ub Actions builds take a long time. Use them when you are pretty
sure everything is OK; otherwise, try to run relevant tests locally
first.
*
Watch over your jobs on the
[
Git
h
ub Actions website
](
http://github.org/haskell/cabal/actions
)
.
*
Watch over your jobs on the
[
Git
H
ub Actions website
](
http://github.org/haskell/cabal/actions
)
.
If you know a build of yours is going to fail (because one job has
already failed), be nice to others and cancel the rest of the jobs,
so that other commits on the build queue can be processed.
...
...
@@ -75,9 +75,9 @@ failures:
a specific operating system? If so, try reproducing the
problem on the specific configuration.
4.
Is the test failing on a Git
h
ub Actions per-GHC build.
4.
Is the test failing on a Git
H
ub Actions per-GHC build.
In this case, if you click on "Branch", you can get access to
the precise binaries that were built by Git
h
ub Actions that are being
the precise binaries that were built by Git
H
ub Actions that are being
tested. If you have an Ubuntu system, you can download
the binaries and run them directly.
...
...
@@ -176,7 +176,7 @@ Other Conventions
*
Our GHC support window is five years for the Cabal library and three
years for cabal-install: that is, the Cabal library must be
buildable out-of-the-box with the dependencies that shipped with GHC
for at least five years.
The Travis CI
checks this, so most
for at least five years.
GitHub Actions
checks this, so most
developers submit a PR to see if their code works on all these
versions of GHC.
`cabal-install`
must also be buildable on all
supported GHCs, although it does not have to be buildable
...
...
@@ -218,7 +218,7 @@ GitHub Ticket Conventions
Each major
`Cabal`
/
`cabal-install`
release (e.g. 3.4, 3.6, etc.) has a
corresponding GitHub Project and milestone. A ticket is included in a release's
project if the release managers are tenatively planning on including a fix for
project if the release managers are ten
t
atively planning on including a fix for
the ticket in the release, i.e. if they are actively seeking someone to work on
the ticket.
...
...
@@ -247,6 +247,11 @@ If your pull request consists of several commits, consider using `squash+merge
me`
instead of
`merge me`
: the Mergify bot will squash all the commits into one
and concatenate the commit messages of the commits before merging.
There is also a
`merge+no rebase`
label. Use this very sparingly, as not rebasing
severely complicates Git history. It is intended for special circumstances, as when
the PR branch cannot or should not be modified. If you have any questions about it,
please ask us.
Changelog
---------
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment