Clarify repo purposes - Githubissues

brainglobe / brainglobe-workflows

Workflows that utilise BrainGlobe tools to perform data analysis and visualisation.

BSD 3-Clause "New" or "Revised" License

9 stars 2 forks source link

Clarify repo purposes #33

Closed alessandrofelder closed 9 months ago

alessandrofelder commented 9 months ago

Description

What is this PR

[ ] Bug fix
[x] Addition of a new feature
[ ] Other

Why is this PR needed? We don't really document our intentions for this repo anywhere AFAIK (I may have missed something).

What does this PR do? Details what this repo is for to developers, to guide our development efforts.

References

Kind of a part of https://github.com/brainglobe/brainglobe.github.io/issues/8 - linking here to remember to move to website, or crosslink.

How has this PR been tested?

N/A

Is this a breaking change?

Does this PR require an update to the documentation?

It is an update to the docs.

Checklist:

[n/a] The code has been tested locally
[n/a] Tests have been added to cover all new functionality (unit & integration)
[n/a] The documentation has been updated to reflect any changes
[x] The code has been formatted with pre-commit

codecov[bot] commented 9 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (afba965) 80.85% compared to head (4b2da4d) 92.80%.

:exclamation: Current head 4b2da4d differs from pull request most recent head fb32f5e. Consider uploading reports for the commit fb32f5e to get more accurate results

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #33 +/- ## =========================================== + Coverage 80.85% 92.80% +11.94% =========================================== Files 28 2 -26 Lines 1494 125 -1369 =========================================== - Hits 1208 116 -1092 + Misses 286 9 -277 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

alessandrofelder commented 9 months ago

I've cancelled the workflow runs for this, as the changes are just to the Readme.

adamltyson commented 9 months ago

Might it be worth emphasising the user facing bits? Talking about developing workflows that link together multiple BG tools (e.g. whole brain cell detection and atlas registration)? The benchmarking & testing stuff should definitely be in it, but it can be less prominent compared with the user-facing content. Once cellfinder is refactored, many users will be directed to this repo.

alessandrofelder commented 9 months ago

I've reformulated to take into account @adamltyson 's comment

alessandrofelder commented 9 months ago

Just noticed that our discussion on https://github.com/brainglobe/brainglobe-workflows/issues/9 is maybe relevant here, too!