DINA-Web / guidelines

Guidelines on how to create, test and deploy modules within the DINA-project
2 stars 1 forks source link

DINA-Web-Release-Guidelines.md (The QA-checklist) #36

Closed Inkimar closed 7 years ago

Inkimar commented 7 years ago

https://github.com/DINA-Web/guidelines/blob/master/DINA-Web-Release-Guidelines.md#passing-the-qa-checks

Today there are 8 bullet points in the checklist. My suggestion: The first 6 points are intuitive and should be in that order. The 2 last one 'Accessibility Guidelines compliance' and 'Security OWASP compliance' , I feel that those 2 points need more introduction so that it becomes clear for the developer on how to use them? ).

Inkimar commented 7 years ago

https://github.com/DINA-Web/guidelines/blob/master/DINA-Web-Release-Guidelines.md#passing-the-qa-checks

Addition on the 4th bullet which states: " *Tests are OK" I would like to have a more specific note on the test/tests that we would like to run. is an acceptance-test sufficient?

mskyttner commented 7 years ago

@Inkimar pls have a look at https://github.com/DINA-Web/guidelines/blob/issue-31/DINA-Web-Release-Guidelines.md where I tried to address some of the issues you brought up, in e1fe56e48bf7f1314671cf739df67a75b3ef5df8

mskyttner commented 7 years ago

I have merged #31 now which is misnamed but it held various review input and changes from @mikkohei13 etc, so the master branch should now be up-to-date with the latest and the tag 0.1tc holds the old versions of the document. Does the current master branch also solve this issue @Inkimar ?

mikkohei13 commented 7 years ago

Thanks @mskyttner . I planned to submit my edits as a pull request, but ended about making them directly to the issue-31 branch. Sorry if this caused trouble for comparing my suggestions to the old version. I'd like to go through details with you, @Inkimar and @idali0226 later.

mskyttner commented 7 years ago

@mikkohei13 no probs! Personally I feel that this repo doesn't contain code that can break so it is more important to keep everything up to date and remove old branches than being cautious - especially since you tagged the material that we're now updating.

I now continue to add some more Licensing and Style stuff, again committing directly to master branch, and will perhaps I will even be bold and remove some of the older branches unless I get any objections from anyone else here....

mskyttner commented 7 years ago

@mikkohei13 @Inkimar I have now removed the other branches and everything I know of should be up-to-date and merged into master... Please have a look and see if any other issues (beyond this one ie #32) that may now be closed due to this update of the docs.

Fixes #32

mskyttner commented 7 years ago

Some of the guidelines are obviously work in progress and may need some quick cleaning up to make better sense. Separate issues can be opened for those purposes.