Skip to content

Commit e00c656

Browse files
committed
Add details to the contribution section
1 parent 8fc6442 commit e00c656

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,16 @@ Please refer to the [user guide](docs/user_guide.md) to get started with docstub
2323

2424
The best way you can help and contribute right now is by trying docstub out!
2525
Feedback to what features might still be missing or where it breaks for you would be greatly appreciated.
26-
Pointers to where the documentation is confusing and unclear.
26+
As well as pointers to where the documentation is confusing and unclear.
27+
Feel welcome to [open an issue](https://github.com/scientific-python/docstub/issues/new/choose)! 🚀
2728

2829
Since docstub is still in early development there isn't an official contribution guide yet.
2930
Features and API are still being heavily extended and the internal structure is still somewhat in flux.
30-
That said, if that only entices you, feel free to open a PR.
31-
But please do check in with an issue before you do so.
31+
The development is, in part, motivated by an effort to add type annotations to the [scikit-image project](https://scikit-image.org).
32+
This may inform some short-term priorities and the roadmap.
33+
34+
That said, docstub is a project for the community and welcomes contributions in any form!
35+
Please do check in with an issue if you are interested in working on something.
3236

3337
Our project follows the [Scientific Python's Code of Conduct](https://scientific-python.org/code_of_conduct/).
3438

docs/user_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,4 +159,4 @@ Two command line options can help addressing these errors gradually:
159159

160160
> [!TIP]
161161
> If you are trying out docstub and have feedback or problems, we'd love to hear from you!
162-
> Feel welcome to [open an issue](https://github.com/scientific-python/docstub/issues/new/choose) 🚀.
162+
> Feel welcome to [open an issue](https://github.com/scientific-python/docstub/issues/new/choose). 🚀

0 commit comments

Comments
 (0)