fluencelabs/marine-rs-sdk
1
0
Fork 0
mirror of https://github.com/fluencelabs/marine-rs-sdk synced 2025-03-14 14:00:49 +00:00
Code Issues Projects Releases Wiki Activity

chore: add contributing page (#106)

Browse Source
This commit is contained in:
Mike Voronov 2023-02-21 14:39:52 +03:00 committed by GitHub
parent 3e9ea360d7
commit 2693e9b6d8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,13 @@
## Contribute Code
You are welcome to contribute to Fluence!
Things you need to know:
1. You need to **agree to the [Contributor License Agreement](https://gist.github.com/fluencelabs-org/3f4cbb3cc14c1c0fb9ad99d8f7316ed7) (CLA)**. This is a common practice in all major Open Source projects. At the current moment, we are unable to accept contributions made on behalf of a company. Only individual contributions will be accepted.
2. **Not all proposed contributions can be accepted**. Some features may, e.g., just fit a third-party add-on better. The contribution must fit the overall direction of Fluence and really improve it. The more effort you invest, the better you should clarify in advance whether the contribution fits: the best way would be to just open an issue to discuss the contribution you plan to make.
### Contributor License Agreement
When you contribute, you have to be aware that your contribution is covered by **[Apache License 2.0](./LICENSE)**, but might relicensed under few other software licenses mentioned in the **Contributor License Agreement**. In particular, you need to agree to the Contributor License Agreement. If you agree to its content, you simply have to click on the link posted by the CLA assistant as a comment to the pull request. Click it to check the CLA, then accept it on the following screen if you agree to it. The CLA assistant will save this decision for upcoming contributions and will notify you if there is any change to the CLA in the meantime.

1
README.md
View File

@ -10,7 +10,6 @@ This SDK empowers developers to create general-purpose Wasm modules and combine
The core component of the SDK is the `#[marine]` macro that should be used with export functions, external blocks, and structures. Let's consider a simple scenario with a module with one export function:
```rust
use marine_rs_sdk::marine;
use marine_rs_sdk::module_manifest;
#[marine]
pub fn greeting(name: String) -> String {