Révision 47a60cdf
feat: add development documentation
| README.md | ||
|---|---|---|
| 166 | 166 |
party configuration that's only included here for reference so changes |
| 167 | 167 |
in the interfaces exposed by this module are not guaranteed to be |
| 168 | 168 |
automatically applied there. |
| 169 |
|
|
| 170 |
## Development |
|
| 171 |
|
|
| 172 |
This module relies on CI testing. To ensure the tests and documentation is complete. |
|
| 173 |
|
|
| 174 |
The following steps are a blueprint for the necessary work to add a new rule to the module: |
|
| 175 |
|
|
| 176 |
1. add a new class for the new rule (there are enough examples) |
|
| 177 |
2. document class and parameters |
|
| 178 |
3. Add a spec test for the new rule to `spec/classes/rules` |
|
| 179 |
4. add the rule to `spec/acceptance/all_rules_spec.rb` |
|
| 180 |
5. update the reference `bundle exec rake strings:generate:reference` |
|
| 181 |
6. commit, push and open a PR |
|
Formats disponibles : Unified diff