Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tiny improvement to contributing guide #284

Merged
merged 2 commits into from
Nov 29, 2023
Merged

Conversation

alessandrofelder
Copy link
Member

@alessandrofelder alessandrofelder commented Nov 29, 2023

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

What does this PR do?

  • fixes a link in the readme
  • adds a notice to contributors that there are local tests.

References

Closes #253

Copy link

codecov bot commented Nov 29, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a5af51c) 86.39% compared to head (cc53b70) 86.39%.

Additional details and impacted files
@@            Coverage Diff            @@
##           mega-fix     #284   +/-   ##
=========================================
  Coverage     86.39%   86.39%           
=========================================
  Files            26       26           
  Lines          1205     1205           
=========================================
  Hits           1041     1041           
  Misses          164      164           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -27,7 +27,7 @@ pip install brainrender
```

## Contributing
Contributions to brainrender are more than welcome. Please see the [developers guide](https://brainglobe.info/developers/index.html).
Contributions to brainrender are more than welcome. Please see the [developers guide](https://brainglobe.info/community/developers/index.html). Note that some tests are only run locally, by specifying `--runslow --runlocal` in `pytest`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A suggestion for the future (i.e. not to be addressed now, but maybe should be an issue). Should this be inverted, so all the tests run by default, but we only pick the fast ones for CI?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opened #285 for this

Copy link
Member

@IgorTatarnikov IgorTatarnikov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! 👍

@IgorTatarnikov IgorTatarnikov merged commit 7dea0d0 into mega-fix Nov 29, 2023
19 checks passed
@IgorTatarnikov IgorTatarnikov deleted the improve-readme branch November 29, 2023 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants