docs: move contributing guide

mdtanker · Feb 19, 2024 · 8d30cda · 8d30cda
1 parent ccb890c
commit 8d30cda
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git 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 → CONTRIBUTING.md b/.github/CONTRIBUTING.md → CONTRIBUTING.md
diff --git 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
@@ -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.
 ```