vinzenz/servicepoint
0
0
Fork 0
mirror of https://github.com/cccb/servicepoint.git synced 2025-01-18 18:10:14 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

add CONTRIBUTING.md

Browse source
This commit is contained in:
Vinzenz Schroeter 2024-09-07 12:59:02 +02:00
parent 64fe0e2997
commit 2b54b944b5
2 changed files with 35 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
CONTRIBUTING.md Normal file
View file

@ -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.

14
README.md
View file

@ -8,10 +8,10 @@ programming languages.
Take a look at the contained crates for language specific information: Take a look at the contained crates for language specific information:
| Language | Readme | | Language | Readme |
|----------|---------------------------------------------------------------------| |-----------|---------------------------------------------------------------------|
| Rust | [servicepoint](crates/servicepoint/README.md) | | Rust | [servicepoint](crates/servicepoint/README.md) |
| C / C++ | [servicepoint_binding_c](crates/servicepoint_binding_c/README.md) | | C / C++ | [servicepoint_binding_c](crates/servicepoint_binding_c/README.md) |
| C# / F# | [servicepoint_binding_cs](crates/servicepoint_binding_cs/README.md) | | .NET (C#) | [servicepoint_binding_cs](crates/servicepoint_binding_cs/README.md) |
## Projects using the library ## 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. To add yourself to the list, open a pull request.
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md).
## What happened to servicepoint2? ## What happened to servicepoint2?
After `servicepoint2` has been merged into `servicepoint`, `servicepoint2` will not continue to get any updates. 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.