Skip to content

Commit b18c7dd

Browse files
authored
Moving contributing info to CONTRIBUTING.md and editing (#12)
* Moving contributing info to CONTRIBUTING.md and editing * Remove contributin info from README.md add a link to CONTRIBUTING.md
1 parent 001a724 commit b18c7dd

File tree

2 files changed

+43
-21
lines changed

2 files changed

+43
-21
lines changed

CONTRIBUTING.md

+41
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,47 @@
44

55
`Wasmnizer-ts` is licensed under the terms in [LICENSE](./LICENSE). By contributing to the project, you agree to the license and copyright terms therein and release your contribution under these terms.
66

7+
### How to contribute
8+
9+
We welcome contributions to Wasmnizer-ts. You can:
10+
11+
- Log a bug or provide feedback with an [issue].
12+
- Submit your changes directly with a [pull request].
13+
14+
### Pull requests
15+
16+
This project follows a simple workflow with contributions delivered as [pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) (PR) against the main branch.
17+
18+
To submit your change:
19+
20+
- Make sure your code is in line with our coding conventions by running `npm run lint` to format the
21+
code.
22+
- Create an [issue] describing the bug the PR fixes or the feature you intend to implement.
23+
- Submit a [pull request] into the main branch.
24+
25+
Your PR will then be reviewed by one or more maintainers. Your PR will be automatically merged
26+
(assuming no conflicts) with one approving review. Maintainers may suggest changes to a PR before
27+
approving.
28+
29+
### Testing
30+
31+
#### Test compilation
32+
33+
This will compile our samples and check if the compiler exit normally, it doesn't guarantee the correctness of the generated wasm module.
34+
35+
``` bash
36+
npm run test
37+
```
38+
39+
#### Validate execution on WAMR
40+
41+
See [validate/wamr](./tools/validate/wamr/README.md) for how to validate results on WAMR
42+
43+
### Code Formatting
44+
45+
Code is required to be formatted with `npm run lint`.
46+
47+
748
### Sign your work
849

950
Please use the sign-off line at the end of the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify

README.md

+2-21
Original file line numberDiff line numberDiff line change
@@ -56,27 +56,8 @@ Please goto [Getting Started](./doc/getting_started.md) for how to use the proje
5656

5757
## Contributing
5858

59-
### Testing
60-
61-
#### Test compilation
62-
63-
This will compile our samples and check if the compiler exit normally, it doesn't guarantee the correctness of the generated wasm module.
64-
65-
``` bash
66-
npm run test
67-
```
68-
69-
#### Validate execution on WAMR
70-
71-
See [validate/wamr](./tools/validate/wamr/README.md) for how to validate results on WAMR
72-
73-
### Code Formatting
74-
75-
Code is required to be formatted with `npm run lint`.
76-
77-
### Submitting Changes
78-
79-
Changes to `Wasmnizer-ts` are managed through github [pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) (PR).
59+
We welcome contributions to Wasmnizer-ts. You can find more details in
60+
[CONTRIBUTING.md](CONTRIBUTING.md) .
8061

8162
## License
8263

0 commit comments

Comments
 (0)