From 47a60cdf9418b825a57fc458cff9d3310cb1f7a2 Mon Sep 17 00:00:00 2001 From: Simon Hoenscheid Date: Mon, 16 Sep 2024 14:58:56 +0200 Subject: [PATCH 1/2] feat: add development documentation --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 4ee0e35..66da3fd 100644 --- a/README.md +++ b/README.md @@ -166,3 +166,16 @@ that could make your life easier when using the module. This is third party configuration that's only included here for reference so changes in the interfaces exposed by this module are not guaranteed to be automatically applied there. + +## Development + +This module relies on CI testing. To ensure the tests and documentation is complete. + +The following steps are a blueprint for the necessary work to add a new rule to the module: + +1. add a new class for the new rule (there are enough examples) +2. document class and parameters +3. Add a spec test for the new rule to `spec/classes/rules` +4. add the rule to `spec/acceptance/all_rules_spec.rb` +5. update the reference `bundle exec rake strings:generate:reference` +6. commit, push and open a PR From 6ee35b9471c7dc89232437bc709f7ea01d3692ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20H=C3=B6nscheid?= Date: Tue, 17 Sep 2024 09:39:33 +0200 Subject: [PATCH 2/2] README.md aktualisieren Co-authored-by: Kenyon Ralph --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 66da3fd..e6b2a36 100644 --- a/README.md +++ b/README.md @@ -177,5 +177,5 @@ The following steps are a blueprint for the necessary work to add a new rule to 2. document class and parameters 3. Add a spec test for the new rule to `spec/classes/rules` 4. add the rule to `spec/acceptance/all_rules_spec.rb` -5. update the reference `bundle exec rake strings:generate:reference` +5. update the reference with `bundle exec rake strings:generate:reference` 6. commit, push and open a PR