Skip to content

Latest commit

 

History

History
111 lines (69 loc) · 3.04 KB

CONTRIBUTING.md

File metadata and controls

111 lines (69 loc) · 3.04 KB
Raw

Welcome to the contributor guide. If you can't find important information you're welcome to edit this page or open a discussion to talk with maintainers.

In this guide you'll find informations about:

Bug reporting

Wordmove is an hard piece of software to debug and it is used by many users with many different environments - Windows also, even if it isn't officially supported by the dev team.

So please, follow the issue template when reporting a bug.

If you're not sure if you're standing in front of a bug, please open a discussion labeling it as "Triage", possibly using this template to report your problem (note: GH's discussions does not support templates ATM):

**Describe the bug**

> A clear and concise description of what the bug is.

**Wordmove command**

> Command used on the CLI: (e.g.: `wordmove pull --all --no-db`)

**Expected behavior**

> A clear and concise description of what you expected to happen.

**movefile.yml**

> Paste (removing personal data) the interesting part, if any, of your `movefile.yml` formatting it inside a code block with `yml` syntax and double checking the indentation.

**Exception/trace**

> Paste (removing personal data) the entire trace of error/exception you encountered, if any

**Environment (please complete the following information):**

- OS:
- Ruby: (`ruby --version`)
- Wordmove: (`wordmove --version`)

**Doctor**

* [x] running the `wordmove doctor` command returns all green

> (If it is not, report the error you got.)

As a general advise: we tend to not support Wordmove's versions older than the latest stable. We'd appreciate your help opening an in depth report if you'd find that an older version is working better for you.

Thank you all for your support and for the love <3

Development

Get Wordmove

  • fork wordmove
  • clone your own repo
  • be sure to check-out the right branch, usually master
Installing Ruby

To install ruby, please, use rbenv or RVM.

Contribute
  • run bundle install to install gem dependencies
  • git checkout -b my_feature_or_fix_name
  • code, commit, push and send a pull request on GitHub

Version bump is considered to be a maintainer's task, so please leave the version alone while working on your branch.

Test Wordmove

Wordmove has a decent test coverage. We require that pull requests does not break tests launched by the CI. In order to launch tests on you dev machine

rake

The command will launch the test suite - written with RSpec - and rubocop.

In order to use the gem locally you can install it

rake install
wordmove --version

or run the executable directly

bin/wordmove --version

Maintainer tasks

ToDo:

  • versioning and version dumping
  • changelog/release
  • publishing the gem