Skip to content

Commit

Permalink
Update contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
vmenger committed Apr 22, 2024
1 parent eace7fc commit 63b09bc
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* :rocket: Open source, created and maintained by the Dutch Clinical NLP community
* :triangular_ruler: Useful out of the box, but customization highly recommended

If you are enthusiastic about using or contributing to `clinlp`, please don't hesitate to get in touch ([email](mailto:analytics@umcutrecht.nl) | [issue](https://github.com/umcu/clinlp/issues/new)). You can find the [documentation](#documentation), [roadmap](#roadmap), the overarching [principles and goals](#principles-and-goals) and how to [contribute](#contributing)futher down :arrow_down:.
If you are enthusiastic about using or contributing to `clinlp`, please don't hesitate to get in touch (via [email](mailto:analytics@umcutrecht.nl) or by creating an [issue](https://github.com/umcu/clinlp/issues/new)). You can find the [documentation](#documentation), [roadmap](#roadmap), the overarching [principles and goals](#principles-and-goals) and how to [contribute](#contributing) futher down :arrow_down:.

## Getting started

Expand Down Expand Up @@ -338,7 +338,11 @@ We hope to extend `clinlp` with new functionality and more complete documentatio

## Roadmap

We keep track of work being done on this project (now and in the future) using GitHub Projects, on this page: [`clinlp` development roadmap](https://github.com/orgs/umcu/projects/3/views/1). All issues created automatically appear on the board, where the can be triaged and assigned.
We keep track of work being done on this project (now and in the future) using GitHub Projects, on this page: [`clinlp` development roadmap](https://github.com/orgs/umcu/projects/3/views/1). All issues created automatically appear on the roadmap, where they will be triaged and assigned.

A more high-level overview of the types of NLP tasks that might be implemented in `clinlp`, with those in the current release marked in green, can be found below. This list is non-exhaustive.

![clinlp-features](media/clinlp-features-v0.6.png)

## Principles and goals

Expand Down Expand Up @@ -370,4 +374,9 @@ Overarching goals:

## Contributing

We value all contributions, and your collaboration is very welcome. We hope to set up some more extensive contributing guidelines in the near future. For now, it suffices to know that we are happy to consider PRs. If you are planning extensive changes, please do get in touch beforehand. This holds both for your own ideas, and for items already on our roadmap. Keep in mind that `clinlp` consists of ~generic~ components that process ~clinical~ text written in ~Dutch~. If your contribution does not meet those three criteria, a separate release might be a better option. We aim for production ready code, that is well tested, scalable, maintainable, SOLID, etc., but we can help with refactoring code to reach that point. We try to use [issues](https://github.com/umcu/clinlp/issues/new) for communication as much as possible, but you can reach the maintainers by [e-mail](mailto:analytics@umcutrecht.nl) if that doesn't work.
`clinlp` is intented as a community project, and as such your contribution is very welcome. We hope to set up some more extensive contributing guidelines in the near future. For now, here is some basic information for starters:

* PRs are welcome, but if you are planning extensive changes, please do get in touch beforehand. This holds both for your own ideas, and for items already on our roadmap.
* Keep in mind that `clinlp` consists of **generic** components that process **clinical** text written in **Dutch**. If your contribution does not meet those three criteria, a separate release might be a better option.
* We aim for production ready code, that is well tested, scalable, maintainable, SOLID, etc., but we can help with refactoring code to reach that point.
* We try to use [issues](https://github.com/umcu/clinlp/issues/new) for communication as much as possible, but you can reach the maintainers by [e-mail](mailto:analytics@umcutrecht.nl) if that doesn't work.
Binary file added media/clinlp-features-v0.6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 63b09bc

Please sign in to comment.