1
0
mirror of https://github.com/ACINQ/eclair.git synced 2024-11-19 01:43:22 +01:00
Commit Graph

8 Commits

Author SHA1 Message Date
Bastien Teinturier
f23e2c5fc5
Clarify contribution guidelines around rebasing PRs (#2591)
It isn't obvious when a contributor should rebase a PR.
Hopefully the additional paragraph clarifies the rules around rebasing.
2023-01-31 13:28:12 +01:00
Bastien Teinturier
431df1fddb
Update various doc files (#2547)
- link to plugins repository
- remove android mention for eclair
- update other implementations (renamed)
- update docker CI action versions
- missing eclair-cli APIs in help
2022-12-30 11:14:56 +01:00
Pierre-Marie Padiou
8e2fc7acd3
Run channel state tests sequentially (#2271)
From scalatest's `ParallelTestExecution` doc:

> ScalaTest's normal approach for running suites of tests in parallel is to run different suites in parallel, but the tests of any one suite sequentially.
> [...]
> To make it easier for users to write tests that run in parallel, this trait runs each test in its own instance of the class. Running each test in its own instance enables tests to use the same instance vars and mutable objects referenced from instance variables without needing to synchronize. Although ScalaTest provides functional approaches to factoring out common test code that can help avoid such issues, running each test in its own instance is an insurance policy that makes running tests in parallel easier and less error prone.

This means that for each single test of the `channel.states` package, we instantiate one actor system, which contains two thread pools. With default settings, that's a minimum of 2*8 threads per individual test.

That's already pretty bad, and with 65cf238 (#2270) we add a factor of 3 on top of that, which makes us go past the OS limits on github CI.

setup | peak thread count | run time
-------|---------------------|----
baseline | 5447 | 5m 44s
sequential | 1927 | 5m 9s (*)

(*) It's actually so bad, that tests run actually faster without parallelization!
2022-05-17 10:03:49 +02:00
Bastien Teinturier
b5b2022efc
Add more PR details to contributing guidelines (#2186)
* Add link to my LN articles in learning resources
* Detail pull request process
2022-02-21 08:12:42 +01:00
Richard Myers
553727cb22
Convert wiki pages in to files in the docs directory and general docs file cleanups (#2165)
Created new files for pages that were in the wiki, but not already in the docs directory. Also made following fixes to  README.md and existing files in the docs directory:

* update bolt links to avoid redirect
* link to logging guide from logging section (README.md)
* fixed typo in Backup section and capitalization of Bitcoin Core (README.md)
* Alice does not need trampoline feature enabled (TrampolinePayments.md)
* link to 2021 edition of Trampoline PR (TrampolinePayments.md)
* fixed API examples and removed quotes from password (API.md)
* use --nodeIds for sendtoroute examples (TrampolinePayments.md and MultipartPayments.md)
* update CLI example 3 to use jq (Usage.md)
* fix typo in docs/FAQ.md
* updated Guide.md to point to all pages that are guides
2022-02-06 20:28:50 +01:00
Bastien Teinturier
8b29edb58d
Add release notes in the repository (#1951)
It's useful to have the release notes directly inside the repository
instead of relying on Github: that lets for example users read them offline.

It also lets us fill the release notes every time we add relevant features
on `master` instead of having to do them all at once when we decide to make
a release.
2021-09-20 14:35:00 +02:00
Bastien Teinturier
e93110b254
Use Github discussions instead of Gitter (#1954)
Remove references to Gitter, so that newcomers use Github discussions
instead.
2021-09-20 09:03:16 +02:00
Bastien Teinturier
fe96132815
Add contributing instructions (#1252) 2020-01-14 16:14:21 +01:00