Skip to content

v2.3.6
Compare
Choose a tag to compare
@github-actions github-actions released this 13 Mar 21:33
· 33 commits to develop since this release
v2.3.6
df4e3c7

Improvements

  • WI: Show knowledge from default branch, not just from feature branches from git (CONDEC-981)
  • WI: Enable to filter and configure link recommendation view (CONDEC-1006)
  • WI: Refactor dashboard code and add documentation in github (CONDEC-996)
    • Issue How to enable navigation from metrics plots in dashboard to detail views?
      • Decision We pass knowledge elements from backend to frontend via REST and use the URL attribute for navigation from metric points to detail views!
        • Pro Passing the entire knowledge elements also enables to use other attributes such as summary/name and type of the element
      • Decision rejected: We used to only pass the keys of the knowledge elements from backend to frontend.
        • Con Parsing of keys to URLs in cumbersome, does not allow to use other attributes such as summary/name and type of the element
    • Issue Where to calculate metrics on the knowledge documentation?
      • Decision We calculate the metrics on the knowledge documentation in the backend in Java! Move metric calculation for branch metrics into backend to unify metric calculation: Add REST API for branch metrics and BranchMetricsCalculator
        • Pro Metric calculation can be easily tested via unit testing
  • WI: Show more positive aspects in quality check tab (CONDEC-1000)
    • Issue How to present the results of quality checking in the quality check view?
      • Decision Show criterion check results in table in quality check view!
        • Pro unresolved: Positive and negative check results can be presented.
    • Issue When should we check whether the linked knowledge for a knowledge element fulfills the DoD?
      • Decision rejected: We used to check whether the linked knowledge for a knowledge element fulfills the DoD all the time.
        • Con Requires a ot of computation resources
      • Decision Only check the linked knowledge for elements that fulfill the DoD in any other criteria!
        • Pro Saves computation resources in comparison to checking the linked knowledge all the time.
  • WI: Enable to export knowledge subgraph as markdown text (CONDEC-1010)
    • Issue How to sort the exported knowledge elements?
      • Decision Sort elements by key when exporting them to Word and JSON!
        • Pro Keeps the order in Jira issue text
        • Con Can be different to for example the order in the indented outline.
      • Alternative We could change the REST API to return an ordered list created with e.g. a depth first iterator.
        • Con Would take more computation effort
  • WI: Enable to show link recommendations within the knowledge graph views and during CIA (CONDEC-1005)
  • WI: Exclude wrong links during transitive linking (CONDEC-1016)
  • WI: Implement that mock PluginSettings stores and returns the gitUri for the TEST project (CONDEC-518)
    • Issue How to mock the git URI for the mock git repo?
      • Decision Enable to store default settings in MockPluginSettings class for unit testing!
    • Issue Should we have one or more git repositories for testing?
      • Alternative We used to have more than one mock git repositories for testing!
      • Decision We have one mock git repositories for testing!
        • Pro This is more efficient than recreating the test git repository all the time.
        • Pro The mock git repository can be easily accessed using the Plugin Settings (see ConfigPersistenceManager class).
        • Con Changes to the git repository (e.g. new commits) during testing has an effect on the test cases that follow. The order of test cases is arbitrary.
  • WI: Add documentation for decision guidance in github (CONDEC-985)
  • WI: Improve just-in-time prompts for developer nudging (CONDEC-938)
    • Issue How much information about each feature should the unified prompt show?
      • Decision The unified prompt should show only enough information as is required to understand what needs to be fixed!
        • Pro The developer can see what is wrong and fix it on a separate tab
        • Con The developer has to switch context to fix the problems
      • Alternative The unified prompt should show as much information as possible!
        • Con Too much information could make the developer more likely to close the prompt without reading it
      • Decision The number of decision guidance suggestions for each related decision problem should be shown!
      • Decision The amount of recommended links/duplicates should be displayed!
      • Decision The elements that are not validated should be displayed with their summaries and classifications!
      • Decision The required rationale coverage and the current coverage should be shown!
  • WI: Pass latest update author via REST API for usage in the ConDec Confluence meeting agenda (CONDEC-1008)
  • WI: Simplify duplicate recognition functionality (CONDEC-1004)
    • Issue How to normalize and rank recommendations?
      • Decision rejected: We use a hypothetical recommendation to the same element as a benchmark for link recommendation and compare the recommendations to other knowledge elements with this recommendation!
        • Con Does not work for rules such as that solution options and decision problems should be recommended, especially if the source element is not decision knowledge.
      • Decision We create the sum of absolute weight values to create a hypothetical best recommendation score!
    • Issue How do we support duplicate recognition within the knowledge documentation?
      • Decision ConDec suggests related knowledge elements to the user as part of the link recommendation feature!
      • Decision We remove the dedicated duplicate recognition functionality!
        • Pro Simplifies the plug-in
        • Pro The link recommendation can also return potential duplicates
    • Issue How can we determine whether two elements are potential duplicates?
      • Decision We mark a recommendation as a potential duplicate if two elements have a very high textual similarity!
  • WI: Introduce new CIA metrics (CONDEC-983)
    • Issue What parameters and filter criteria should be considered during change impact analysis (CIA)? (CONDEC-847)
      • Decision We use a rule-based and a dependency/traceability-based change impact analysis (CIA) approach!
      • Decision We enable change impact analysis (CIA) in the knowledge graph views so that all the filter criteria can be applied during CIA!
    • Issue Which metrics/rules do we use for change impact analysis (CIA)?
      • Alternative discarded: Number of past updates
        • Con Is already included in a different metric
      • Decision If solution option
      • Decision If decision problem
      • Decision Ratio between outbound and inbound links
      • Decision Low average age
      • Decision Same decision group
      • Decision Same creator
      • Decision Same component
      • Decision Same knowledge type
      • Decision Textual similarity
      • Decision Number of distinct update authors
      • Decision Outbound links only
      • Alternative discarded: Likelihood
        • Con Time-consuming calculation due to iteration over all elements in a project
  • WI: Introduce adding and deleting links between code files (CONDEC-1009)
  • WI: Introduce new CIA configuration settings (CONDEC-987)
    • Issue Which configuration possibilities should the rationale manager have regarding change impact analysis (CIA)?
      • Alternative discarded: Rule-dependant values, e.g. time setting for timely coupling
        • Pro Allows more fine-tuning of CIA
        • Con Difficult implementation for rules that are also utilized by link recommendation system
      • Decision Weight factor for individual rules
        • Pro Allows easy adjustments of individual rule impact, thereby increasing usability.
      • Decision Default ruleset
        • Pro Best practice ruleset can be enabled by default, thereby helping developers.
  • WI: Simplify and enforce assignment of decision groups (CONDEC-1012)
    • Issue Which definition of done criterion should ConDec have wrt. decision grouping?
      • Alternative We could enable the rationale manager to configure how many decision groups need to be assigned.
      • Decision The definition of done (DoD) requires that at least a decision level and one decision group is assigned to every decision problem, decision, and alternative!
        • Con Not configurable
        • Pro Quite strikt, but helps us to study which types of decisions developers document
  • WI: Add dashboard item for decision levels and decision groups (CONDEC-1013)
    • Issue How can the rationale manager and the developers see which decision groups are used in the project and which decisions are assigned to the decision levels and decision groups?
      • Decision We create a dashboard item for decision levels and decision groups (using plot, in particular pie charts)!
        • Pro Pie charts give a good visual overview
      • Decision We create a separate decision grouping view that presents the decision levels/groups and the respective knowledge elements!
        • Pro Enables changing the group names and assigning elements
  • WI: Allow negative CIA rule weights that reverse rule effects (CONDEC-1007)
    • Issue unresolved: How can the change propagation rules for CIA be weighed?
  • WI: Add CIA tooltip (CONDEC-982)
    • Issue How to explain the result of change impact analysis to the developers?
      • Decision The developers are shown a tooltip when hovering over knowledge elements to get an explanation for CIA!
    • Issue What information should the CIA tooltip provide?
      • Decision The CIA tooltip shows the impact value of the knowledge element and a detailed explanation regarding the calculation, i.e. which rules were applied and their weights!
  • WI: Consolidate CIA and link recommendation score calculation (CONDEC-1011)
  • WI: Consolidate CIA metrics and link recommendation ruleset (CONDEC-1001)

Bug Fixes

  • B: Extraction of code files from two repositories is not working (CONDEC-980)
  • B: NullException when accessing UpdateDateAndAuthor (CONDEC-1003)
Assets 3
Loading