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