From 5ebaeca422ca4aed5bc23e8f5b8b454367afcd83 Mon Sep 17 00:00:00 2001 From: Fabian Brinkmann Date: Mon, 22 Apr 2024 13:28:59 +0200 Subject: [PATCH] review according to ahms-5 --- CONTRIBUTING.rst | 9 ++++----- README.rst | 4 ++-- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 6548fd02..645f4934 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -5,7 +5,10 @@ Contributing ============ Contributions are welcome, and they are greatly appreciated! Every little bit -helps, and credit will always be given. +helps, and credit will always be given. The following helps you to start +contributing to pyfar. General guidelines for example regarding the style +of code and documentation are part of the You can find our general +guidelines in the `pyfar community`_. Types of Contributions ---------------------- @@ -69,9 +72,5 @@ Ready to contribute? Here's how to set up `pyfar` for local development using th 7. Submit a pull request on the develop branch through the GitHub website. -Guide lines ------------ - -You can find our general guidelines in the `pyfar community`_. .. _pyfar community: https://pyfar-gallery.readthedocs.io/en/latest/community.html diff --git a/README.rst b/README.rst index 18e1789f..15b7d834 100644 --- a/README.rst +++ b/README.rst @@ -47,9 +47,9 @@ Check out the `contributing guidelines`_ if you want to become part of pyfar. .. _pyfar workshop: https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb .. _pyfar example gallery: https://pyfar-gallery.readthedocs.io/en/latest/examples_gallery.html -.. _pyfar documentation: https://pyfar.readthedocs.io/en/stable +.. _pyfar documentation: https://pyfar.readthedocs.io .. _pyfar.org: https://pyfar.org -.. _SoundFile: https://pysoundfile.readthedocs.io/en/stable +.. _SoundFile: https://pysoundfile.readthedocs.io .. _libsndfile: http://www.mega-nerd.com/libsndfile/ .. _help section: https://pyfar-gallery.readthedocs.io/en/latest/help.html .. _contributing guidelines: https://pyfar.readthedocs.io/en/stable/contributing.html