Merge branch 'bemanproject:main' into main

Author: Andres-Salamanca

.github/workflows/pre-commit.yml

@@ -41,3 +41,4 @@ jobs:
           tool_name: pre-commit
           level: warning
           reviewdog_flags: "-fail-level=error"
+          githubt_token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -41,15 +41,10 @@ e.g.:
 
 ## Help Welcome!
 
-There are plenty of things which need to be done. Some of these
-are listed in the [issues section](https://github.com/bemanproject/execution/issues).
-Other contributions are, of course, also welcome. Aside from contributing
-code the project welcomes reports on usage experience, code reviews, defect
-reports, features requests, etc. There are plenty contribution opportunities.
-
-If you want to contribute, you won't be left alone! Please e-mail
-[Dietmar Kühl](mailto:[email protected]) if you want help or mentoring
-for contributing to the library.
+There are plenty of things which need to be done. See the
+[contributions page](https://github.com/bemanproject/execution/docs/contributing.md)
+for some ideas how to contribute. The [resources page](https://github.com/bemanproject/execution/docs/resources.md)
+contains some links for general information about the sender/receivers and `std::execution`.
 
 ## Build
 

docs/contributing.md

@@ -0,0 +1,36 @@
+<!-- SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception -->
+
+# Contributing to `beman::execution`
+
+We welcome all constructive contributions! You will have something you
+can contribute independent of your level expertise!
+
+There is a huge range of contributions needed and welcome! Here is an
+incomplete list of starting points for contributions:
+
+* Some documentation is unclear.
+* There is some bug somewhere. That can be a typo in some documentation,
+   a logic error in the implementation, a deviation from the standard
+   specification, etc.
+* Something reference moved or the reference is out of date.
+* When compiling the code on your system warnings or even errors are
+    created.
+* The [issues page](https://github.com/bemanproject/execution/issues) lists
+    known issues.
+* The implememtation of a component may be missing.
+* The layout of some pages related to the project can be improved.
+* Some behaviour of a component isn't tested or documented.
+* You found something which should be linked from the
+    [resources](https://github.com/bemanproject/execution/docs/resources.md) page.
+* There are [pull requests](https://github.com/bemanproject/execution/pulls)
+    which could be reviewed.
+* This very page or list is lacking something.
+
+Whatever it is, you can improve the project! Ideally, create a pull
+request with your proposed change. If you think you can't do that
+for whatever reason, create an issue (if possible checking if the
+issue isn't reported, yet) explaining what should be done. You can
+possibly use a pull request or an issue to ask for help with something
+you want to contribute. You can also send a message to one of the
+contributors with your suggestion, e.g. to
+[Dietmar Kühl](mailto:[email protected]).

docs/resources.md

@@ -0,0 +1,11 @@
+<!-- SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception -->
+
+# Resources Related to `beman::execution`
+
+This page has links to some resources related to this repository:
+
+* Lucian Teodorescu's [Overload](https://accu.org/journals/nonmembers/overload_issue_members/) article [Senders/Receivers: An Introduction](https://accu.org/journals/overload/32/184/teodorescu/).
+* Eric Niebler's Working with Asynchrony Generically: A Tour of C++ [Executors part 1](https://youtu.be/xLboNIf7BTg?si=JhXh55lCGW9-EuQl)/[part 2](https://youtu.be/6a0zzUBUNW4?si=7We2cRiJD0eJ7jm9).
+* Goran Arandelovic's presentation [Introduction to Sender/Receiver Framework and `std::execution`](https://eel.is/c++draft/#exec) at [Using std::cpp](https://eventos.uc3m.es/105614/programme/using-std-cpp-2024.html) 2024
+* The [`std::execution](https://wg21.link/p2300) proposal.
+* The [[exec]](https://eel.is/c++draft/#exec) section of the draft standard.