Skip to content

Commit

Permalink
Merge pull request #28 from melissawm/upstream-instructions
Browse files Browse the repository at this point in the history
Add notes about upstreaming content
  • Loading branch information
psobolewskiPhD authored Oct 11, 2024
2 parents 9f43764 + eeb663c commit 4513336
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ You can also click the `Use this template` button in the GitHub web interface fo

![Use this template button on GitHub interface](napari-workshops/docs/images/00-template.png)

Once you have created your workshop, if you would like the event to be listed [in napari.org](https://napari.org/stable/further-resources/napari-workshops.html), feel free to submit a pull request to https://github.com/napari/docs
> [!TIP]
> Once you have created your workshop, if you would like the event to be listed [in the workshops page in napari.org](https://napari.org/stable/further-resources/napari-workshops.html), feel free to [submit a pull request to the napari/docs repository](https://github.com/napari/docs/blob/main/docs/further-resources/napari-workshops.md).
## Documentation

Expand Down
11 changes: 11 additions & 0 deletions napari-workshops/docs/build_your_workshop.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,3 +122,14 @@ Select Creative Commons Attribution 4.0 International (CC-BY 4.0) license if you
## Enable a citation file for your repository
Check [the GitHub documentation](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files) for more details on how to use the `citation.cff` file to enable others to cite your repository.
## Upstream your ideas!
If you spot something that can be improved in this template, or if you want to
suggest adding a notebook to the base materials, feel free to reach out! You can:
- [Create an issue](https://github.com/napari/napari-workshop-template/issues/new)
with suggestions for improvement;
- [Submit a Pull Request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to the workshop template repository with your suggested changes;
- [Reach out on Zulip chat](https://napari.zulipchat.com/) to tell us about your workshop and give feedback on the template or napari itself;
- Add your workshop materials (including video, if available) to [the Workshops page in the napari documentation website](https://napari.org/stable/further-resources/napari-workshops.html).

0 comments on commit 4513336

Please sign in to comment.