Documentation Updates

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,31 +1,31 @@
 ---
-name: "Bug report \U0001F41B"
+name: Bug report
 about: Create a report to help us improve
 title: ''
 labels: bug, needs-triage
 assignees: ''
 
 ---
 
-[NOTE]: # ( ^^ Provide a general summary of the issue in the title above. ^^ )
+^^ Provide a general summary of the issue in the title above. ^^
 
-**Description**
-[NOTE]: # ( Describe the problem you're encountering. )
-[TIP]:  # ( Do NOT share sensitive information, whether personal, proprietary, or otherwise! )
+## Description
+Describe the problem you're encountering.
+TIP: Do NOT share sensitive information, whether personal, proprietary, or otherwise!
 
-**Expected Behavior**
-[NOTE]: # ( Tell us what you expected to happen. )
+## Expected Behavior
+Tell us what you expected to happen.
 
-**[Troubleshooting](https://discuss.newrelic.com/t/troubleshooting-frameworks/108787) or [NR Diag](https://docs.newrelic.com/docs/using-new-relic/cross-product-functions/troubleshooting/new-relic-diagnostics) results**
-[NOTE]: # ( Provide any other relevant log data. )
-[TIP]:  # ( Scrub logs and diagnostic information for sensitive information )
+## [Troubleshooting](https://forum.newrelic.com/s/hubtopic/aAX8W0000008bSoWAI/troubleshooting-frameworks) or [NR Diag](https://docs.newrelic.com/docs/using-new-relic/cross-product-functions/troubleshooting/new-relic-diagnostics) results
+Provide any other relevant log data.
+TIP:  Scrub logs and diagnostic information for sensitive information.
 
-**Steps to Reproduce**
-[NOTE]: # ( Please be as specific as possible. )
-[TIP]:  # ( Link a sample application that demonstrates the issue. )
+## Steps to Reproduce
+Please be as specific as possible.
+TIP:  Link a sample application that demonstrates the issue.
 
-**Your Environment**
-[TIP]:  # ( Include as many relevant details about your environment as possible including the running version of New Relic software and any relevant configurations. )
+## Your Environment
+Include as many relevant details about your environment as possible including the running version of the Python agent, the Python version being used and any other relevant environment information.
 
-**Additional context**
-[TIP]:  # ( Add any other context about the problem here. For example, relevant community posts or support tickets. )
+## Additional context
+Add any other context about the problem here. For example, relevant community posts or support tickets.

.github/ISSUE_TEMPLATE/config.yml

@@ -15,5 +15,5 @@
 blank_issues_enabled: false
 contact_links:
   - name: Troubleshooting
-    url: https://github.com/newrelic/newrelic-python-agent/blob/main/README.rst#support
+    url: https://github.com/newrelic/newrelic-python-agent/blob/main/README.md#support
     about: checkout the README for troubleshooting directions

.github/ISSUE_TEMPLATE/enhancement.md

@@ -0,0 +1,26 @@
+---
+name: Enhancement request
+about: Suggest an idea for a future version of this project
+title: ''
+labels: enhancement, needs-triage
+assignees: ''
+---
+
+^^ Provide a general summary of the request in the title above. ^^
+
+## Summary
+
+Provide a brief overview of what the new feature is all about.
+
+## Desired Behavior
+
+Tell us how the new feature should work. Be specific.
+TIP:  Do NOT give us access or passwords to your New Relic account or API keys!
+
+## Possible Solution
+
+Not required. Suggest how to implement the addition or change.
+
+## Additional context
+
+[TIP]:  Why does this feature matter to you? What unique circumstances do you have?

.github/pull_request_template.md

@@ -1,4 +1,4 @@
-_Before contributing, please read our [contributing guidelines](https://github.com/newrelic/newrelic-python-agent/blob/main/CONTRIBUTING.rst) and [code of conduct](https://github.com/newrelic/.github/blob/master/CODE_OF_CONDUCT.md)._
+_Before contributing, please read our [contributing guidelines](https://github.com/newrelic/newrelic-python-agent/blob/main/CONTRIBUTING.md) and [code of conduct](https://github.com/newrelic/.github/blob/master/CODE_OF_CONDUCT.md)._
 
 # Overview
 Describe the changes present in the pull request
@@ -10,6 +10,6 @@ Include a link to the related GitHub issue, if applicable
 The agent includes a suite of tests which should be used to
 verify your changes don't break existing functionality. These tests will run with
 Github Actions when a pull request is made. More details on running the tests locally can be found
-[here](https://github.com/newrelic/newrelic-python-agent/blob/main/CONTRIBUTING.rst#testing-guidelines),
+[here](https://github.com/newrelic/newrelic-python-agent/blob/main/CONTRIBUTING.md#testing-guidelines),
 For most contributions it is strongly recommended to add additional tests which
 exercise your changes.

.mega-linter.yml

@@ -15,9 +15,6 @@ ENABLE_LINTERS: # If you use ENABLE_LINTERS variable, all other linters will be
   - MARKDOWN_MARKDOWNLINT
   - PYTHON_RUFF
   - PYTHON_RUFF_FORMAT
-  - RST_RST_LINT
-  - RST_RSTCHECK
-  - RST_RSTFMT
   - YAML_PRETTIER
   - YAML_V8R
   - YAML_YAMLLINT
@@ -26,3 +23,6 @@ PYTHON_RUFF_CONFIG_FILE: pyproject.toml
 PYTHON_RUFF_CLI_LINT_MODE: project
 PYTHON_RUFF_FORMAT_CONFIG_FILE: pyproject.toml
 PYTHON_RUFF_FORMAT_CLI_LINT_MODE: project
+MARKDOWN_MARKDOWN_LINK_CHECK_FILTER_REGEX_EXCLUDE: "tests/.*"
+MARKDOWN_MARKDOWNLINT_FILTER_REGEX_EXCLUDE: "tests/.*"
+MARKDOWN_MARKDOWNLINT_ARGUMENTS: "--disable=MD041"

CONTRIBUTING.md

@@ -0,0 +1,197 @@
+# Contributing to the Python Agent
+
+Thanks for your interest in contributing to the
+`New Relic Python Agent`! We look forward to engaging with you.
+
+## How to Contribute
+
+Contributions are always welcome. Before contributing please read the
+[code of
+conduct](https://github.com/newrelic/.github/blob/main/CODE_OF_CONDUCT.md)
+and [search the issue tracker](https://github.com/newrelic/newrelic-python-agent/issues); your issue may have
+already been discussed or fixed in [main]{.title-ref}. To contribute,
+[fork](https://help.github.com/articles/fork-a-repo/) this repository,
+commit your changes, and [send a Pull
+Request](https://help.github.com/articles/using-pull-requests/).
+
+Note that our [code of
+conduct](https://github.com/newrelic/.github/blob/main/CODE_OF_CONDUCT.md)
+applies to all platforms and venues related to this project; please
+follow it in all your interactions with the project and its
+participants.
+
+## How to Get Help or Ask Questions
+
+Do you have questions or are you experiencing unexpected behaviors after
+modifying this Open Source Software? Please engage with the "Build on
+New Relic" space in the [Explorers
+Hub](https://discuss.newrelic.com/c/build-on-new-relic/Open-Source-Agents-SDKs),
+New Relic\'s Forum. Posts are publicly viewable by anyone, please do not
+include PII or sensitive information in your forum post.
+
+## Contributor License Agreement ("CLA")
+
+We\'d love to get your contributions to improve the Python Agent! Keep
+in mind that when you submit your Pull Request, you\'ll need to sign the
+CLA via the click-through using CLA-Assistant. You only have to sign the
+CLA one time per project. If you\'d like to execute our corporate CLA,
+or if you have any questions, please drop us an email at
+<[email protected]>.
+
+For more information about CLAs, please check out Alex Russell\'s
+excellent post, [Why Do I Need to Sign
+This?](https://infrequently.org/2008/06/why-do-i-need-to-sign-this/).
+
+## Feature Requests
+
+Feature requests should be submitted in the [Issue
+tracker](https://github.com/newrelic/newrelic-python-agent/issues), with a description of the expected behavior &
+use case, where they\'ll remain closed until sufficient interest, [e.g.
+:+1:
+reactions](https://help.github.com/articles/about-discussions-in-issues-and-pull-requests/),
+has been [shown by the
+community](https://github.com/newrelic/newrelic-python-agent/issues?q=label%3A%22votes+needed%22+sort%3Areactions-%2B1-desc).
+Before submitting an Issue, please search for similar ones in the
+[closed
+issues](https://github.com/newrelic/newrelic-python-agent/issues?q=is%3Aissue+is%3Aclosed+label%3Aenhancement).
+
+## Filing Issues & Bug Reports
+
+We use GitHub issues to track public issues and bugs. If possible,
+please provide a link to an example app or gist that reproduces the
+issue. When filing an issue, please ensure your description is clear and
+includes the following information.
+
+- Project version (ex: 1.4.0)
+- Custom configurations (ex: flag=true)
+- Any modifications made to the Python Agent
+
+### A note about vulnerabilities
+
+New Relic is committed to the security of our customers and their data.
+We believe that providing coordinated disclosure by security researchers
+and engaging with the security community are important means to achieve
+our security goals.
+
+If you believe you have found a security vulnerability in this project
+or any of New Relic\'s products or websites, we welcome and greatly
+appreciate you reporting it to New Relic through
+[our bug bounty program](https://docs.newrelic.com/docs/security/security-privacy/information-security/report-security-vulnerabilities/).
+
+## Setting Up Your Environment
+
+This Open Source Software can be used in a large number of environments,
+all of which have their own quirks and best practices. As such, while we
+are happy to provide documentation and assistance for unmodified Open
+Source Software, we cannot provide support for your specific
+environment.
+
+## Developing Inside a Container
+
+To avoid the issues involved with setting up a local environment,
+consider using our prebuilt development container to easily create an
+environment on demand with a wide selection of Python versions
+installed. This also comes with the
+[tox](https://github.com/tox-dev/tox) tool (See Testing Guidelines) and
+a few packages preinstalled.
+
+While we cannot provide direct support in setting up your environment to
+work with this container, we develop it in the open and provide this
+documentation to help reduce the setup burden on new contributors.
+
+### Prerequisites
+
+1. Install [Docker](https://www.docker.com/) for you local operating
+    system.
+
+2. Login to the [GitHub Container
+    Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic)
+    through Docker.
+
+3.  
+
+    Install Either:
+
+    :   -   [VS Code](https://code.visualstudio.com/) onto your local
+            system (recommended).
+        -   The [Dev Container
+            CLI](https://github.com/devcontainers/cli) in your terminal.
+            (Requires a local copy of
+            [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).)
+
+### Steps for VS Code
+
+1. Ensure Docker is running.
+2. Install the [VS Code Extension for Dev
+    Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
+    into VS Code.
+3. In VS Code, open the command pallette (Ctrl-Shift-P on Windows/Linux
+    or Cmd-Shift-P on Mac) and search for and run \"Dev Containers:
+    Rebuild and Reopen in Container\".
+4. Wait for the container to build and start. This may take a long time
+    to pull the first time the container is run, subsequent runs should
+    be faster thanks to caching.
+5. To update your container, open the command pallette and run \"Dev
+    Containers: Rebuild Without Cache and Reopen in Container\".
+
+### Steps for Command Line Editor Users (vim, etc.)
+
+1. Ensure Docker is running.
+2. From the root of this repository, run
+    `devcontainer up --workspace-folder=.` to start the container. The
+    running container ID will be displayed, which is useful for
+    subsequent steps.
+3. To gain shell access to the container, run
+    `docker exec -it <container-id> /bin/bash`. Alternative shells
+    include `zsh` and `fish`.
+4. Navigate to the `/workspaces` folder to find your source code.
+5. To stop the container, run `exit` on any open shells and then run
+    `docker stop <container-id>`. `docker ps` may be helpful for finding
+    the ID if you\'ve lost it.
+
+### Personalizing Your Container
+
+1. If you use a dotfiles repository (such as
+    [chezmoi](https://www.chezmoi.io/)), you can configure your
+    container to clone and install your dotfiles using [VS Code dotfile
+    settings](https://code.visualstudio.com/docs/devcontainers/containers#_personalizing-with-dotfile-repositories).
+2. To install extra packages and features, you can edit your local copy
+    of the .devcontainer/devcontainer.json file to use specific [Dev
+    Container Features](https://containers.dev/features). A few common
+    needs are already included but commented out.
+
+## Pull Request Guidelines
+
+Before we can accept a pull request, you must sign our [Contributor
+Licensing Agreement](#contributor-license-agreement-cla), if you have
+not already done so. This grants us the right to use your code under the
+same Apache 2.0 license as we use for this project in general.
+
+Minimally, the [test suite](#testing-guidelines) must pass for us to
+accept a PR. Ideally, we would love it if you also added appropriate
+tests if you\'re implementing a feature!
+
+Please note that integration tests will be run internally before
+contributions are accepted.
+
+Additionally:
+
+1. Ensure any install or build dependencies are removed before the end
+    of the layer when doing a build.
+2. Increase the version numbers in any examples files and the README.md
+    to the new version that this Pull Request would represent. The
+    versioning scheme we use is [SemVer](http://semver.org/).
+3. You may merge the Pull Request in once you have the sign-off of two
+    other developers, or if you do not have permission to do that, you
+    may request the second reviewer to merge it for you.
+
+## Testing Guidelines
+
+The Python Agent uses [tox](https://github.com/tox-dev/tox) for testing.
+The repository uses tests in tests/.
+
+You can run these tests by entering the tests/ directory and then
+entering the directory of the tests you want to run. Then, run the
+following command:
+
+`tox -c tox.ini -e [test environment]`