doc_contract 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89489dd28689e53d39925212a07429c986e64f01c50592b2d080341028e53312
-  data.tar.gz: 2d5103ec8f7881c54bcd763a36d40daf151b50d353594631ba92956a6f1beec2
+  metadata.gz: 19b2e7620eb38e143f377e284ef114d73d8ecaded35f8922d0b75e7c0928f6a5
+  data.tar.gz: 57633ce96bae4ced8db47c6e2a0071b7447b61ecc145358e7102e4970072e8e8
 SHA512:
-  metadata.gz: 4a0f9caa408900aabf7cad451bc66457543aca5db89f55afd577872db375eb672f1016652adda7f71ccd06474af64907b50d4be1386c268021e74ac4febb9bda
-  data.tar.gz: 38bbbe73181acfcb8ebec70205d28d239b30f7b5e1b9e5b61bff9bc1ef661e53f2b1dbf73d06c22d2748094386a67f223a7a574e50d8674407b5d71255a7c899
+  metadata.gz: f492dd061c367f22446893d10173575757f9720d003b43e366f8cbbddaef5bb2166c171eeb5cdfdbec0c4686cc3e61a6d4388b387479fbe22f41c4a61f2017ef
+  data.tar.gz: fab2d0c24a47f34cf2461e7553ff368a685ee346aaa50c45cb6f3a95fe32ef826a200b526fbd8164bb1310db6e7b5d700a18f3918fc181df73401fe4c202bb9a

data/README.md

@@ -94,6 +94,8 @@ a VAT of 21%.
 And more contract stuff
 ```
 
+NOTE: the `to_words` handlebars helper uses the (numbers\_and\_words)[https://github.com/kslazarev/numbers\_and\_words] gem.
+
 ## Installation
 
 ### Install the system dependencies
@@ -184,8 +186,43 @@ To change for example the icon, see the options at the [fomantic-ui](https://fom
 
 ### Screenshot
 ![Edit template scnreenshot](/spec/dummy/public/DocContract-template-edit.png)
+
 ## Contributing
+There are many ways to contribute. Here some example steps that should work.
+
+### 1. Fork the repository
+Go to the original repository at https://gitlab.com/benja-2/doc\_contract and [fork](https://gitlab.com/benja-2/doc_contract/-/forks/new) the project.
+Then `git clone` your code on your local computer.
+
+If you are in the git repository directory you can tell your system to use the local code when actually the
+gitlab repository is specified for faster debugging. To achieve this type:
+
+```bash
+bundle config local.doc_contract .
+```
+
+### 2. Add your forked codebase to a project
+To start from zero, create a new rails (> 7) project and add the `doc_contract` gem configured to use `gitlab` as a base:
+
+```bash
+rails new my_doc_contract_project
+cd my_doc_contract_project
+```
+
+Then in the `Gemfile`
+```ruby
+git_source(:gitlab) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "git@gitlab.com:#{repo_name}.git"
+end
+
+gem 'doc_contract', gitlab: '<your gitlab name>/doc_contract', branch: :master
+```
 Contribution directions go here.
 
+## CHANGELOG
+The CHANGELOG can be found using 
+[CHANGELOG.md](/CHANGELOG.md)
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/doc_contract/version.rb

@@ -1,3 +1,3 @@
 module DocContract
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end