Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Contribution Guidelines which replaces current wiki #43

Merged
merged 1 commit into from
Dec 2, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Contribution Guidelines

Thanks for your interest in contributing to **E2E TensorFlow Lite Tutorials**!

Please follow these steps when contributing:

Step 1. (Optional) Propose a project idea with either a brief description or an overview page if you wish to add more context about it.
Step 2. (Optional) Create issues for requesting help, in general in these areas:

* Model training
* Model conversion to tflite (and add metadata) <-- tflite model can reside in a team members' GitHub, in your project repo or on TFHub. Please validate the tflite with metadata in the Android app especially if you are publishing it to TFHub for wider adoption.
* Android app
* iOS app
* write an E2E tutorial

Step 3. If you are interested in helping out, please create a project repo and add the link to the E2E TFLite Tutorials README. Update project to "In Progress" section.
Step 4. After project is completed, move from "In progress " to "Completed" section on E2E TFLite Tutorials. And request with a PR to add your project to [awesome-tflite].

When createing a PR, please make sure to:
* Provide a meaningful title such as "Update README.md to [action]" and do not title it as "Update README.md".
* Make sure there are no broken links.