Skip to content

Commit 770a71a

Browse files
authored
Create CONTRIBUTING.md
Signed-off-by: Joël R. Langlois <[email protected]>
1 parent 61a2470 commit 770a71a

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

.github/CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing
2+
3+
We want to make contributing to this project as easy and transparent as possible.
4+
5+
# Feedback & Changes
6+
7+
We welcome your Issues and Pull Requests!
8+
9+
## Get Started
10+
11+
1. Create a Pull Request with your proposed changes, and please explain why these changes are useful.
12+
* This is great if it's a small change. If you have something complex to offer or suggest, please discuss this over an Issue first.
13+
2. If you've added code that should be tested, please create relevant unit tests
14+
* Have a look at the codebase for examples about creating unit tests.
15+
3. Verify that there are no issues in your build.
16+
* Please ensure your test passes locally at the very least.
17+
* Ideally, you will at least test your changes on all of our supported platforms:
18+
* Both desktop and mobile (ie: macOS, Windows, iOS, Android).
19+
4. Address any feedback in code review promptly.
20+
* Any lingering Issues or Pull Requests will be closed.
21+
22+
# License
23+
24+
By contributing to examples, you agree that your contributions will be licensed under the LICENSE.md file in the root directory of this repository.

0 commit comments

Comments
 (0)