documentation - community standards

.github/pull_request_template.md

@@ -0,0 +1,42 @@
+# Pull Request Description
+
+## Changes Made
+*Describe the changes you've made in this pull request. What does this PR do?*
+
+## Motivation and Context
+*Why is this change required? What problem does it solve?*
+
+*If it fixes an open issue, please link to the issue here.*
+
+## Type of Change
+**Please check the options that are relevant:**
+- [ ] Bug fix (non-breaking change that fixes an issue)
+- [ ] New feature (non-breaking change that adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+- [ ] This change requires a documentation update
+
+## Testing Performed
+**Describe the tests you ran to verify your changes:**
+- Test scenario 1
+- Test scenario 2
+
+## Screenshots (if appropriate)
+*Add screenshots to help explain your changes.*
+
+## Dependencies
+**List any dependencies that are required for this change:**
+- Dependency 1
+- Dependency 2
+
+## Checklist
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+
+## Additional Notes
+*Add any other context about the pull request here.*
+
+## Reviewers
+**@mention relevant team members or individuals you'd like to review this PR**

.github/workflows/build.yml

@@ -2,9 +2,15 @@ name: Build
 
 on:
   push:
-    branches: [ main ]
+    branches:
+      - main
+    paths-ignore:
+      - "*.md"
   pull_request:
-    branches: [ main ]
+    branches:
+      - main
+    paths-ignore:
+      - "*.md"
 
 permissions:
   pull-requests: write
@@ -50,7 +56,7 @@ jobs:
         name: coverage-report
         path: coverage/
 
-  build:
+  compile:
     needs: test
     runs-on: ubuntu-latest
     steps:
@@ -80,4 +86,4 @@ jobs:
         diff: true
         diff-branch: main
         coverage-summary-title: "Code Coverage Summary"
-        diff-storage: coverage/reports
+        diff-storage: coverage-reports

README.md

@@ -11,9 +11,9 @@
 1. [Overview](#-overview)
 2. [Features](#%EF%B8%8F-features)
 3. [Installation](#-installation)
-4. [Usage](#-usage)
-    - [Setting the API Key](#set-api-key)
-    - [Generating maps](#generate-maps)
+4. [Usage](#%EF%B8%8F-usage)
+    - [Setting the API Key](#-setting-your-api-key)
+    - [Generating maps](#%EF%B8%8F-generate-maps)
         - [Generate a procedural map with seed and size](#generate-a-procedural-map-with-seed-and-size)
         - [Generate a procedural map with seed and size (staging branch)](#generate-a-procedural-map-with-seed-and-size-staging-branch)
         - [Generate a procedural map with random seed](#generate-a-procedural-map-with-random-seed)
@@ -22,10 +22,10 @@
         - [Generate maps from a csv file (procedural and custom)](#generate-maps-from-a-csv-file-procedural-and-custom)
         - [Download generated maps](#download-generated-maps)
         - [Download generated maps to a specified directory](#download-generated-maps-to-a-specified-directory)
-    - [Opening maps in the browser](#🌐-opening-maps-in-the-browser)
-    - [Using a `csv` file](#📚-using-a-csv-file)
-6. [Storage Locations](#where-is-stuff-stored)
-7. [Disclaimers](#️-disclaimers)
+    - [Opening maps in the browser](#-opening-maps-in-the-browser)
+    - [Using a `csv` file](#-using-a-csv-file)
+6. [Storage Locations](#-file-structurelocations)
+7. [Disclaimers](#%EF%B8%8F-disclaimers)
 
 ## 📖 Overview
 
@@ -49,7 +49,7 @@ This tool takes map parameter input either via command line or `csv` file (colum
 
 ### Quick Install
 
-If you just want to get up and running quickly, we provide a binary for just aboout every platform. You can download the binary for your platform from our [releases](https://github.com/maintc/rustmaps-cli/releases) page.
+If you just want to get up and running quickly, the project provides a binary for `macOS`, `Linux`, and `Windows`. You can download the binary for your platform from the [releases](https://github.com/maintc/rustmaps-cli/releases) page.
 
 ### Developers and golang people
 
@@ -73,7 +73,6 @@ Available Commands:
   completion  Generate the autocompletion script for the specified shell
   generate    Generate custom and procedural maps
   open        Open generated maps in the browser
-  tutorial    Run through the tutorial and learn to get started
 
 Flags:
   -h, --help               help for rustmaps

SECURITY.md

@@ -0,0 +1,8 @@
+# Reporting Security Issues
+
+We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
+
+To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/maintc/rustmaps-cli/security/advisories/new) tab.
+
+The mainloot team will send a response indicating the next steps in handling your report. After the initial reply to your report, the team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.
+