Skip to content

Commit 467b25e

Browse files
authored
Merge pull request #2 from lucshi/master
set up readme, contributing and bug template.
2 parents a75a5f0 + bdd5351 commit 467b25e

File tree

13 files changed

+407
-1
lines changed

13 files changed

+407
-1
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Contributing to WAMR
2+
=====================
3+
As an open-source project, we welcome and encourage the community to submit patches directly to the project. In our collaborative open source environment, standards and methods for submitting changes help reduce the chaos that can result from an active development community.
4+
We want to make contributing to this project as easy and transparent as possible, whether it's:
5+
- Reporting a bug
6+
- the current state of the code
7+
- Submitting a fix
8+
- Proposing new features
9+
10+
License
11+
=====================
12+
WAMR uses the permissive open source `Apache 2.0 license`_ that allows you to freely use, modify, distribute and sell your own products that include Apache 2.0 licensed software.
13+
Any contributions you make will be under the same license. Feel free to contact the maintainers if that's a concern.
14+
15+
Code changes
16+
===================
17+
We Use Github Flow, So All Code Changes Happen Through Pull Requests. Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
18+
19+
- If you've added code that should be tested, add tests. Ensure the test suite passes.
20+
- Avoid use macros for different platforms. Use seperate folder of source files to host diffeent platform logic.
21+
- Put macro definitions inside share_lib/include/config.h if you have to use macro.
22+
- Make sure your code lints and compliant to our coding style.
23+
- Extend the application library is highly welcome.
24+
25+
Coding Style
26+
===============================
27+
Please use [K&R](https://en.wikipedia.org/wiki/Indentation_style#K.26R) coding style, such as 4 spaces for indentation rather than tabs etc.
28+
We suggest use Eclipse like IDE or stable coding format tools to make your code compliant to K&R format.
29+
30+
Report bugs
31+
===================
32+
We use GitHub issues to track public bugs. Report a bug by [open a new issue](https://github.com/intel/wasm-micro-runtime/issues/new).

ISSUE_TEMPLATE/bug_report.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. Linux]
28+
- Version [e.g. 22]
29+
30+
**Additional context**
31+
Add any other context about the problem here.

0 commit comments

Comments
 (0)