From 2b54b944b55086fac4e614d5fac0f462b80441cd Mon Sep 17 00:00:00 2001 From: Vinzenz Schroeter Date: Sat, 7 Sep 2024 12:59:02 +0200 Subject: [PATCH] add CONTRIBUTING.md --- CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ README.md | 20 +++++++++----------- 2 files changed, 35 insertions(+), 11 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..06b144f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# Contributing + +Contributions are accepted in any form (issues, documentation, feature requests, code, review, ...). + +All creatures welcome. + +## Pull requests + +Feel free to create a PR, even if your change is not done yet. + +Mark your PR as a draft as long as you do not want it to be merged. + +The main branch is supposed to be a working version, including language bindings, +which means sometimes your PR may be merged into a temporary development branch. + +## Language bindings + +Pull requests for your preferred language will be accepted. +If there is no code generator, it should call the C ABI methods provided by `servicepoint_binding_c`. +It should be able to send most of the basic commands in a way the simulator accepts, receiving is +not required for the merge. + +It is okay for the feature set of a language binding to lag behind the one of the rust crate. +This also means you do not have to expose a feature to all the language bindings when adding something to the core. + +If your change may break other language bindings, please note that in your PR description so someone can check them. diff --git a/README.md b/README.md index f19c2b1..a4e2836 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,11 @@ programming languages. Take a look at the contained crates for language specific information: -| Language | Readme | -|----------|---------------------------------------------------------------------| -| Rust | [servicepoint](crates/servicepoint/README.md) | -| C / C++ | [servicepoint_binding_c](crates/servicepoint_binding_c/README.md) | -| C# / F# | [servicepoint_binding_cs](crates/servicepoint_binding_cs/README.md) | +| Language | Readme | +|-----------|---------------------------------------------------------------------| +| Rust | [servicepoint](crates/servicepoint/README.md) | +| C / C++ | [servicepoint_binding_c](crates/servicepoint_binding_c/README.md) | +| .NET (C#) | [servicepoint_binding_cs](crates/servicepoint_binding_cs/README.md) | ## Projects using the library @@ -26,12 +26,10 @@ Take a look at the contained crates for language specific information: To add yourself to the list, open a pull request. +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md). + ## What happened to servicepoint2? After `servicepoint2` has been merged into `servicepoint`, `servicepoint2` will not continue to get any updates. - -## Contributing - -Contributions are accepted in any form (issues, documentation, feature requests, code, review, ...). - -All creatures welcome.