Skip to content

Commit

Permalink
add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kaesaecracker committed Sep 7, 2024
1 parent 64fe0e2 commit bf9c1ad
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 6 deletions.
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

## 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, ...).
See [CONTRIBUTING.md](CONTRIBUTING.md).

All creatures welcome.
## What happened to servicepoint2?

After `servicepoint2` has been merged into `servicepoint`, `servicepoint2` will not continue to get any updates.

0 comments on commit bf9c1ad

Please sign in to comment.