Skip to content

Commit

Permalink
Merge pull request #394 from DOV-Vlaanderen/docs-contributions
Browse files Browse the repository at this point in the history
Add some documentation for the contrib section.
  • Loading branch information
Roel authored Sep 26, 2023
2 parents 23d97d1 + 60cfdf8 commit 71bf54a
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 8 deletions.
27 changes: 19 additions & 8 deletions .github/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,14 @@ see this `Open Source Guide`_.
Share the love
^^^^^^^^^^^^^^

Think pydov is useful? Let others discover it, by telling them in person, via Twitter_ or a blog post.

.. _Twitter: https://twitter.com/DOVdovVO
Think pydov is useful? Let others discover it, by telling them in person, via social media or a blog post.

Using pydov for a paper you are writing? Consider citing it:

Roel Huybrechts, Stijn Van Hoey, Pieter Jan Haest, Johan Van de Wauw, Peter Desmet & Joris Synaeve. (2020). DOV-Vlaanderen/pydov. Zenodo. http://doi.org/10.5281/zenodo.2788681
Roel Huybrechts, Stijn Van Hoey, Pieter Jan Haest, Johan Van de Wauw, Joris Synaeve, Guillaume Vandekerckhove, Killian Paenen, Peter Desmet, Gilles Trenson, sweco-begilt, Joris Van den Bossche, marleenvd, & Shaun. (2023). Zenodo. https://doi.org/10.5281/zenodo.2788680

Ask a question ⁉️
^^^^^^^^^^^^^^^^^
Ask a question
^^^^^^^^^^^^^^

Using pydov and got stuck? Browse the documentation_ to see if you
can find a solution. Still stuck? Post your question as a `new issue`_ on GitHub.
Expand Down Expand Up @@ -127,5 +125,18 @@ Care to fix bugs or implement new functionality for pydov? Awesome! Have a
look at the `issue list`_ and leave a comment on the things you want
to work on.

Make sure to setup your development environment as explained in the :ref:`installation instructions for developers <devinstallation>`.
Once setup, check the :ref:`development guidelines <dev-guidelines>` to see ow we develop the pydov package.
Make sure to setup your development environment and check the :ref:`development guidelines <dev-guidelines>` to see ow we develop the pydov package.

Share your work
~~~~~~~~~~~~~~~

Made something cool using pydov, that might be useful for others too? Feel free to share it, and be sure to let us know so we can include
a reference in our documentation and help promote it.

Smaller scripts and tools can be included in the `contrib`_ section of our repository too. Don't hesitate to open a pull request to add yours!

.. _contrib: https://github.com/DOV-Vlaanderen/pydov/tree/master/contrib

The contribution section is not maintained by the pydov core team and does not require the same level of e.g. test coverage as does the main
pydov code. The minimum to provide besided the script itself is a README.md with minimal information on what it does and how to use it,
and a requirements.txt file if your script requires additional dependencies.
19 changes: 19 additions & 0 deletions contrib/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Contributions

Welcome to the contribution section of the pydov repository! This section
includes scripts and tools made by contibutors (you!) that might benefit others too.

## Add yours!

If you made a script using pydov that you think might also be useful for others,
don't hesitate to open a pull request to add it here!

The minimum to provide besides the script itself is:
- a README.md containing minimal information on what it does and how to use it
- a requirements.txt if your script requires additional dependencies

## Disclaimer

The scripts and tools provided here are not maintained by the pydov core team
and do not require the same level of code quality and test coverage as the
pydov core modules.

0 comments on commit 71bf54a

Please sign in to comment.