* for `class` attribute use use BEM convention - Block__Element_Modifier / multi-word-block-name__multi-word-element-name_modifier-name_modifier-value for complete reference go to https://en.bem.info/methodology/quick-start/
* for `class` attribute use use BEM convention - Block__Element_Modifier / multi-word-block-name__multi-word-element-name_modifier-name_modifier-value for complete reference go to https://en.bem.info/methodology/quick-start/
@@ -104,10 +104,12 @@ In case that issue is not provided, more detailed description is required.
Should be short and descriptive `refs #ISSUE_ID`.
GOOD:
- 500 error on issue edit (refs #123456)
- New version gantt 2.0
BAD:
- fix
- patch
- refs #123456
...
...
@@ -201,3 +203,13 @@ Check for it with `ruby -wc PATH_TO_FILE`. In orders to check all files :
```
find . -name "*.rb" -type f -exec ruby -wc {} \; | grep -v OK
```
##### Versioning
All our RYSy are versioned by semantic versioning. For details please see https://semver.org/#semantic-versioning-200
1. level - MAJOR - includes changes which are release specific - lots of changes, refactoring and whole new features, migrations and etc.
2. level - MINOR - includes new small features, migrations, minor change of internal logic
3. level - PATCH (or bug-fix) - its only for bug-fixing or harmless changes, such as documentation, readme, etc. ! This version must not include migrations and breaking chagnes !
We introduce new way of development plugins for Redmine (and Easy Redmine of course) which is almost same as developing standard rails gems.
# Introduce
RYS engines are separated to few gems, and source code is on github. So for full documentation what is RYS and how it works, please check our github page.
https://github.com/easysoftware/rys
# Lukas's personal workflow
How to start develop with RYS? There are some of my recommendations...
## You need Redmine of Easy Redmine first
Because RYS is designed for developing (easy) Redmine plugins, you need download one of it.
We have prepared simple generator of RYS engines
...
...
@@ -20,7 +24,7 @@ We have prepared simple generator of RYS engines
1. Add in your Redmine gem "rys"
2. Run rails generate of RYS
rails generate rys:plugin NAME
### Move generated code to work directory
...
...
@@ -37,32 +41,31 @@ So I take our 'devel' repository, clone as `dummy` and remove *_ALL unnecessary
This dummy I have symlinked to `test/dummy` in RYS engine.
### Prepare to test
1. bundle install - based my experience you need run this many times :)
1. Be sure you have configured `config/database.yml` in your dummy.