guide

parent f767be7d
......@@ -28,6 +28,6 @@ Plugin can be generated by:
Additional info:
rails generate redmine_extensions:plugin --help
On this level it's required to write at least basic test (touching of routes and asserting success).
Guidelines for testing and it's settings could be find [on this page](./TESTS.md)
# DEPRECATED
use https://git.easy.cz/external/guidelines/-/wikis/home
# DEV Guide
1. [Development types](#development-types)
......@@ -101,12 +104,12 @@ In case that issue is not provided, more detailed description is required.
#### 1. Name
Should be short and descriptive `refs #ISSUE_ID`.
Should be short and descriptive `#ISSUE_ID What is it about`.
GOOD:
- 500 error on issue edit (refs #123456)
- New version gantt 2.0
- #123456 500 error on issue edit (refs #123456)
- #78910 New version gantt 2.0
BAD:
......@@ -124,11 +127,13 @@ More detailed description of MR, if there's issue linked, it's should be linked
#### 3. Branches
Target branch is defined by rules of repository. More in chapter [Repositories](./REPOSITORIES.md)
Target branch is defined by rules of repository. More in chapter repositories.
#### 4. Assignment
When creating always assign MR to yourself.
When creating assign MR to yourself in case you want a review, for example in case WIP.
If you are done with work, pass MR for review and assign it to `@gitmakers` = which something like "pool"
#### 5. After creation
......@@ -136,7 +141,7 @@ After creation **always** check MR. Changes should match MR and conflict must be
If CI is enabled in repository it's required to wait for tests to pass before moving it.
If CI passes MR is assigned to responsible reviewer or repository owner. In case of Easy Project it's @jaro, @lukas, @ondra.
Only MR with passed tests are reviewed.
### Rules of all levels of review
......
......@@ -57,7 +57,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
......@@ -86,19 +86,19 @@ This dummy I have symlinked to `test/dummy` in RYS engine.
How I do this... (working example)
1. Get Easy Redmine
git clone devel -b devel devel
2. Setup Easy Redmine (database.yml)
bundle install --without rmagick xapian
3. Generate RYS
rails g rys:plugin ruzovy_jednorozec --path ../
4. Prepare dummy
git clone devel -b devel dummy
cd dummy/plugins
rm -r * && git checkout easyproject easy_job
......@@ -108,16 +108,16 @@ How I do this... (working example)
vim config/database.yml
5. Link dummy to RYS
cd ../ruzovy_jednorozec
mkdir test
test folder is in `.gitignore` by default
ln -s [~/projects/ or absolute path]dummy test/dummy
6. Make it together
bundle install --without rmagick xapian
rake app:db:create app:db:migrate
rake app:easyproject:install # this work from ER 05.00
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment