... | ... | @@ -95,98 +95,3 @@ We have two main branches: |
|
|
* 'develop' - the code here is less stable than the master branch since it is work-in-progress. Tested code in this branch is merged into 'master' for client reviews.
|
|
|
* Each issue is developed and tested in its own branch before being merged into 'develop'.
|
|
|
|
|
|
## Review and feedback
|
|
|
|
|
|
Dione provides **one testing handover issue** summarising dev work completed that is ready to test, including links to each relevant issue. Each issue is labelled with a release date for improved searching.
|
|
|
|
|
|
NCBI does testing according to the sign-off criteria, summarised at the beginning of each issue.
|
|
|
|
|
|
When providing feedback, please check the issues list for [features](https://gitlab.coko.foundation/ncbi/ncbi/-/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name[]=feature) that haven't been developed yet or [bugs](https://gitlab.coko.foundation/ncbi/ncbi/-/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name[]=bug) that are known. A ‘bug’ issue comprises some unexpected design or behaviour relevant to the sign-off criteria, and should include clear steps to reproduce the issue to avoid development delay.
|
|
|
|
|
|
When NCBI has completed testing against the sign-off criteria, Let Dione know in the testing handover issue.
|
|
|
|
|
|
|
|
|
### Testing agreements
|
|
|
|
|
|
#### Communiticating releases and feedback
|
|
|
|
|
|
Coko creates a testing issue for NCBI when there is a new release – at minimum every two weeks so issues don’t build up.
|
|
|
|
|
|
Coko notes in that issue an exact checklist of new things ready to test in structure of (see proposed key for a common language to use about workflow and file types for all testers to understand):
|
|
|
|
|
|
> * Feature A for User to do X in workflow 1 and 2 only - this relates to following User Story (Epic and checklist story item)
|
|
|
> * Feature B for User to do Y in workflow 3a only - this relates to following User Story (Epic and checklist story item)
|
|
|
> * Action A for User to process file type Z in workflow 2a - this relates to following User Story (Epic and checklist story item)
|
|
|
|
|
|
Coko also notes in that issue exactly which bugs and improvements they would like NCBI to test – these bug and improvement issues should be focused on usability and things we can do in the UI or actions we can test in terms of processing, etc.
|
|
|
|
|
|
Record these bugs and improvements as:
|
|
|
|
|
|
>Please check following bugs and improvements:
|
|
|
>
|
|
|
>Bug 1 – if relevant, this relates to the following User Story (Epic and checklist story item)
|
|
|
>Improvement 2
|
|
|
|
|
|
|
|
|
NCBI provides feedback for releases in form of:
|
|
|
|
|
|
1. New bug ticket using Coko bug issue template IF new bug - Feature A or Action B does not work as expected - user cannot do X or Y in workflow 1
|
|
|
2. New improvement ticket using Coko New Feature issue template if we think something could be improved - Feature A works but it is confusing because of Z and we really think it would be better if it could do D because ....
|
|
|
3. Reopen existing ticket if still does not do as expected (Bug tickets should state what should be expected from a user point of view)
|
|
|
4. Reopen existing improvement ticket if it still does not reduce what was confusing or difficult (Feature tickets should state this clearly in the description)
|
|
|
5. If NCBI has questions about the build or was not able to test something they will note this in the Release testing ticket and will not close it until response from Coko in case based on their response they can test it, and so on until everything is resolved.
|
|
|
|
|
|
(Note: As discussed in DDWG, only critical "New improvement" issues can be addressed for the initial release.)
|
|
|
|
|
|
##### Terminology
|
|
|
|
|
|
Proposed key for everyone to use for communicating contexts NCBI must know to complete testing
|
|
|
|
|
|
**Workflow Key**
|
|
|
|
|
|
* Word workflow
|
|
|
* PDF wholebook workflow
|
|
|
* PDF chapter-processed workflow
|
|
|
* XML wholebook workflow
|
|
|
* XML chapter-processed workflow
|
|
|
|
|
|
**File Types Key**
|
|
|
|
|
|
* FTP submission (make sure everyone has representative samples of types of FTP submissions - one file, multiple files, etc)
|
|
|
* Manual upload (make sure everyone has representative samples of types of manual submissions - one file, multiple files, etc)
|
|
|
* Funded content (needs to be noted if manual and/or FTP submission because of key matching and integrity issues)
|
|
|
|
|
|
**Additional Critical contexts**
|
|
|
|
|
|
* Database type documents (chapter-processed with database source type)
|
|
|
* Book (book processed)
|
|
|
* Contributed chapters (chapter-processed content in a book source type)
|
|
|
* Content belonging to a collection (regular series or funded collection also needs to be noted)
|
|
|
|
|
|
#### NCBI review site
|
|
|
|
|
|
* The recview site URL: https://ncbi.cloud68.co
|
|
|
* The site will be updated every Tuesday with whichever issues have been completed and merged.
|
|
|
* Dione will provide release 'walk-throughs' in the bimonthly review meeting when possible and will continue to create a summary release issues.
|
|
|
|
|
|
#### For FTP submitted content
|
|
|
|
|
|
*Related issues #449 and #455*
|
|
|
|
|
|
Mock FTP folders have been set up in Coko's FTP account:
|
|
|
|
|
|
```
|
|
|
$ tree /am/ftp-private/bookshelf/coko/mockftp/
|
|
|
/am/ftp-private/bookshelf/coko/mockftp/
|
|
|
|-- AHRQ
|
|
|
|-- CADTH
|
|
|
|-- NICE
|
|
|
|-- TaylorFrancis
|
|
|
|-- nap
|
|
|
|-- springerbooks
|
|
|
`-- wellcome_trust
|
|
|
```
|
|
|
|
|
|
1. Coko team will only submit packages to `CADTH` folder. A corresponding Oragnization exists in the BCMS, accessible at Coko's staging site only.
|
|
|
2. NCBI team will submit packages to all other folders. Corresponding Oragnizations exists in the BCMS, accessible at [NCBI's testing site](http://ncbi.coko.foundation) only. These orgs will remain stable in future update of your testing site so you can continue to use them.
|
|
|
3. Files for testing are maintained is a shared [Nextcloud folder](https://nextcloud.coko.foundation/s/zp26xmB3eP6Px3w) (password protected) |
|
|
\ No newline at end of file |