add doc for contributing

pludoni · Feb 12, 2024 · 7de63c6 · 7de63c6
1 parent 1661412
commit 7de63c6
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,14 @@
+# Contributing Guide
+
+[![Gem Version](https://badge.fury.io/rb/extract_i18n.svg)](https://badge.fury.io/rb/extract_i18n)
+
+## Workflow
+- fork the repository and setup the environment
+- create a new branch: `feature/xxx`, `fix/xxx`
+- commit codes and tests to finish the feature or bug fix
+- push to remote and create a pull request
+
+## Environment setup
+- use ruby version: 2.6
+- install dependencies: `bundle install`
+- make sure the test passed: `bundle exec rspec`