Skip to content

Commit

Permalink
Merge branch 'feature/cleanup-and-documentation' of https://github.co…
Browse files Browse the repository at this point in the history
…m/coenm/RepoM into feature/cleanup-and-documentation
  • Loading branch information
coenm committed Aug 14, 2023
2 parents 5a02e3b + a75d42c commit 70ac542
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/Ordering.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

The order of the repositories shown in RepoM is customizable. The default is alphabetical on the repository name.

Orderings are defined in yaml using repository-`comparers` and repository-`scorers` and you can switch between different orderings at any given time using the hamburger menu in RepoM.
Orderings are defined in yaml using repository-`comparers` and repository-`scorers`. You can switch at any given time between orderings using the hamburgermenu in RepoM.

## Definitions

A `comparer` compares two repositories resulting in an order between the two. The comparison is defined by the type of comparer. It is possible to compare by repository name (assending order) or to compare repositories by the timestamp of the last action performed by RepoM.

`Scorers` however calculate a score over exactly one repository. It does not compare repositories. Comparing repositories by score, use the `score-comparer@1`.

## Comparers

Expand Down Expand Up @@ -39,3 +45,8 @@ Comparer specific properties:

- `comparers`: A list of comparers. The sum of the results of the comparers will be used as final result.<!-- endInclude -->
<!-- endInclude -->

## Scorers

** Could not find include 'RepositoriesScorerConfigurationTests.CoreScorersMarkdown.verified.md' ** <!-- singleLineInclude: RepositoriesScorerConfigurationTests.CoreScorersMarkdown.verified.md -->

0 comments on commit 70ac542

Please sign in to comment.