From 8d30cda624eeebd56d7297d60270d90587e83591 Mon Sep 17 00:00:00 2001 From: mdtanker Date: Sat, 16 Dec 2023 00:23:45 +0100 Subject: [PATCH] docs: move contributing guide --- .github/config.yml | 4 ++-- .github/CONTRIBUTING.md => CONTRIBUTING.md | 0 docs/contributing.md | 2 +- docs/index.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) rename .github/CONTRIBUTING.md => CONTRIBUTING.md (100%) diff --git a/.github/config.yml b/.github/config.yml index 234b6c68..e0d1c25f 100644 --- a/.github/config.yml +++ b/.github/config.yml @@ -5,13 +5,13 @@ # Comment to be posted to on first time issues newIssueWelcomeComment: > - 👋 Thanks for opening your first issue here! Please make sure you filled out the template with as much detail as possible. You might also want to take a look at our [contributing guidelines](https://github.com/mdtanker/invert4geom/blob/main/docs/contribute.md). + 👋 Thanks for opening your first issue here! Please make sure you filled out the template with as much detail as possible. You might also want to take a look at our [contributing guidelines](https://invert4geom.readthedocs.io/en/latest/contributing.html). # Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome # Comment to be posted to on PRs from first time contributors in your repository newPRWelcomeComment: > 💖 Thanks for opening this pull request! 💖 - Please make sure you read our [contributing guidelines](https://github.com/mdtanker/invert4geom/blob/main/.github/CONTRIBUTING.md). + Please make sure you read our [contributing guidelines](https://invert4geom.readthedocs.io/en/latest/contributing.html). A few things to keep in mind: * If you need help writing tests, take a look at the existing ones for inspiration. If you don't know where to start, let us know and we'll walk you through it. * All new features should be documented. It helps to write the docstrings for your functions/classes before writing the code. This will help you think about your code design and results in better code. diff --git a/.github/CONTRIBUTING.md b/CONTRIBUTING.md similarity index 100% rename from .github/CONTRIBUTING.md rename to CONTRIBUTING.md diff --git a/docs/contributing.md b/docs/contributing.md index 01fbe425..66c1f98d 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,3 +1,3 @@ -```{include} ../.github/CONTRIBUTING.md +```{include} ../CONTRIBUTING.md ``` diff --git a/docs/index.md b/docs/index.md index 11e2cb6e..f44c1938 100644 --- a/docs/index.md +++ b/docs/index.md @@ -129,7 +129,7 @@ mind before you update Invert4Geom to a newer version. ```{admonition} How to contribute :class: seealso -Please, read our [Contributor Guide](https://github.com/mdtanker/invert4geom/blob/main/.github/CONTRIBUTING.md) to learn +Please, read our [Contributor Guide](contributing.md) to learn how you can contribute to the project. ```