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.

Sign up for GitHub

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

Jump to bottom

Tiny improvement to contributing guide #284

Merged
merged 2 commits into from
Nov 29, 2023
Merged

Tiny improvement to contributing guide #284

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0eac8d
Note about slow tests in contributing paragraph
alessandrofelder Nov 29, 2023
cc53b70
fix link to dev docs
alessandrofelder Nov 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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


## Citing brainrender
If you use `brainrender` in your work, please cite:
Expand Down