Moves Readme, contributing and Code of Conduct into .github/ dir and updates references

Author: Lissy93

CODE_OF_CONDUCT.md renamed to .github/CODE_OF_CONDUCT.md

@@ -3,7 +3,7 @@
 > This is our code of conduct, based upon the [Contributor Covenant](https://www.contributor-covenant.org/).
 > It outlines a set of core values and norms that are essential in a just and equitable software commons.
 > You must abide by these if you wish to contribute to this project.
-> For contributing guidelines - see [`CONTRIBUTING.md`](https://github.com/Lissy93/git-into-open-source/blob/main/CONTRIBUTING.md)
+> For contributing guidelines - see [`CONTRIBUTING.md`](https://github.com/Lissy93/git-into-open-source/blob/main/.github/CONTRIBUTING.md)
 >
 > **TLDR; Don't be a d!ck**
 

CONTRIBUTING.md renamed to .github/CONTRIBUTING.md

@@ -20,7 +20,7 @@
 ## Git In!
 
 The following users have contributed to this repo, by sharing their thoughts and ideas about open source.<br />
-Join them by editing the [`git-in-here.yml`](git-in-here.yml) file, and following the instructions in [`CONTRIBUTING.md`](/CONTRIBUTING.md) to submit a PR.
+Join them by editing the [`git-in-here.yml`](git-in-here.yml) file, and following the instructions in [`CONTRIBUTING.md`](/.github/CONTRIBUTING.md) to submit a PR.
 
 
 <!-- git-in-start -->
@@ -34,7 +34,7 @@ Join them by editing the [`git-in-here.yml`](git-in-here.yml) file, and followin
 
 Submitting contributions to any repository is easy!
 
-The first step is to check out the projects contributing guidelines ([here's ours](/CONTRIBUTING.md)). These will usually outline setup instructions, and give you pointers as to where and how you can contribute.
+The first step is to check out the projects contributing guidelines ([here's ours](/.github/CONTRIBUTING.md)). These will usually outline setup instructions, and give you pointers as to where and how you can contribute.
 
 Next you'll need to either fork and clone the repo, or if it's a small change you can just edit it via the GitHub UI. [Here is a step-by-step guide](/guides/submit-your-first-pr-cli.md) to help you get started with that.
 

README.md renamed to .github/README.md

@@ -40,7 +40,7 @@ jobs:
         run: |
           git config --global user.name "Liss-Bot"
           git config --global user.email "[email protected]"
-          git add README.md
+          git add .github/README.md
           if git diff --staged --quiet; then
             echo "Nothin new added, so nothing to commit, exiting..."
           else

.github/workflows/insert-comments.yml

@@ -41,7 +41,7 @@ jobs:
           git config --global user.name "Liss-Bot"
           git config --global user.email "[email protected]"
           git pull origin main
-          git add README.md
+          git add .github/README.md
           if git diff --staged --quiet; then
             echo "Nothin new added, so nothing to commit, exiting..."
           else

.github/workflows/insert-resources.yml

@@ -86,15 +86,15 @@ def main():
             logging.warning(f"Skipping {guide['file']} as doc could not be found in {source_file_path}")
 
         # Copy the contributing guidleines from ./CONTRIBUTING.md to /web/src/pages/contributing.md
-        contributing_source_path = project_root / "CONTRIBUTING.md"
+        contributing_source_path = project_root / ".github/CONTRIBUTING.md"
         contributing_destination_path = project_root / "web/src/pages/contributing.md"
         content = contributing_source_path.read_text()
         contributing_headers = (
             f"---\n"
             f"layout: ../layouts/MarkdownLayout.astro\n"
             f"title: Contributing Guidelines\n"
             f"---\n\n"
-            f"<!-- This file was auto-generated from ./CONTRIBUTING.md -->\n\n"
+            f"<!-- This file was auto-generated from ./.github/CONTRIBUTING.md -->\n\n"
         )
         write_file(contributing_destination_path, contributing_headers + content)
         logging.info(f"Copied {contributing_source_path} to {contributing_destination_path}")

lib/copy_resources_to_site.py

@@ -30,7 +30,7 @@
 """ The directory where this script is located """
 SCRIPT_DIR = os.path.dirname(os.path.abspath(__file__))
 """ The relative path to the markdown file to update"""
-README_PATH = os.path.join(SCRIPT_DIR, "..", "README.md")
+README_PATH = os.path.join(SCRIPT_DIR, "..", ".github/README.md")
 """ The relative path to the YAML file containing the user-contributed content """
 CONTRIBUTORS_FILE_PATH = os.path.join(SCRIPT_DIR, "..", "git-in-here.yml")
 

lib/insert_contributor_content.py

@@ -17,7 +17,7 @@
 project_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 resources_file_path = os.path.join(project_root, 'resources.yml')
 guides_directory = os.path.join(project_root, 'guides')
-readme_path = os.path.join(project_root, 'README.md')
+readme_path = os.path.join(project_root, '.github/README.md')
 
 logger.info("Reading the resources.yml file...")
 # Read the resources.yml

lib/insert_resource_list.py

@@ -3,5 +3,5 @@ layout: ../layouts/MarkdownLayout.astro
 title: Contributing Guidelines
 ---
 
-<!-- This file was auto-generated from ./CONTRIBUTING.md -->
+<!-- This file was auto-generated from .github/CONTRIBUTING.md -->