From 7de63c65a2fba9046fa128ea242a232eca490e31 Mon Sep 17 00:00:00 2001 From: cccccroge Date: Mon, 12 Feb 2024 20:41:14 +0800 Subject: [PATCH] add doc for contributing --- CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9960d32 --- /dev/null +++ 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`