docs: move contributing documentation to its own file

CONTRIBUTING.md

@@ -0,0 +1,86 @@
+# Contributing
+
+We welcome contributions to the project. This document provides information and
+guidelines for contributing.
+
+## Development Environment
+
+This repository includes a configuration for a development container using the
+[VS Code Remote - Containers extension](https://code.visualstudio.com/docs/remote/containers).
+This setup allows you to develop within a Docker container that already has all
+the necessary tools and dependencies installed.
+
+The development container is based on Ubuntu 20.04 (Focal) and includes the
+following tools:
+
+- AWS CLI
+- Node.js
+- TypeScript
+- Docker CLI
+- Terraform
+- Open Policy Agent
+
+### Prerequisites
+
+- [Docker](https://www.docker.com/products/docker-desktop) installed on your
+  local machine.
+- [Visual Studio Code](https://code.visualstudio.com/) installed on your
+  local machine.
+- [Remote - Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
+  for Visual Studio Code.
+
+### Usage
+
+1. Clone and open this repository:
+
+    ```bash
+    git clone https://github.com/sgtoj/terraform-docker-artifact-packager.git
+    code terraform-docker-artifact-packager
+    ```
+
+2. When prompted to "Reopen in Container", click "Reopen in Container". This
+   will start building the Docker image for the development container. If you're
+   not prompted, you can open the Command Palette (F1 or Ctrl+Shift+P), and run
+   the "Remote-Containers: Reopen Folder in Container" command.
+
+3. After the development container is built and started, you can use the
+   Terminal in Visual Studio Code to interact with the container. All commands
+  you run in the Terminal will be executed inside the container.
+
+### Troubleshooting
+
+If you encounter any issues while using the development container, you can try
+rebuilding the container. To do this, open the Command Palette and run the
+"Remote-Containers: Rebuild Container" command.
+
+## Contribution Guidelines
+
+We appreciate your interest in contributing to the project. Here are some
+guidelines to help ensure your contributions are accepted.
+
+### Issues
+
+- Use the GitHub issue tracker to report bugs or propose new features.
+- Before submitting a new issue, please search to make sure it has not already
+  been reported. If it has, add a comment to the existing issue instead of
+  creating a new one.
+- When reporting a bug, include as much detail as you can. Include the version
+  of the module you're using, what you expected to happen, what actually
+  happened, and steps to reproduce the bug.
+
+### Pull Requests
+
+- Submit your changes as a pull request.
+- All pull requests should be associated with an issue. If your change isn't
+  associated with an existing issue, please create one before submitting a pull
+  request.
+- In your pull request, include a summary of the changes, the issue number it
+  resolves, and any additional information that might be helpful for
+  understanding your changes.
+- Make sure your changes do not break any existing functionality. If your
+  changes require updates to existing tests or the addition of new ones, include
+  those in your pull request.
+- Follow the existing code style. We use a linter to maintain code quality, so
+  make sure your changes pass the linter checks.
+
+Thank you for your contributions!

README.md

@@ -55,56 +55,8 @@ for more details on these variables.
 |-------------------------|------------------------------------------------|
 | `artifact_package_path` | The local path where the artifact is copied to |
 
-## Development Environment
+## Contributing
 
-This repository includes a configuration for a development container using the
-[VS Code Remote - Containers extension](https://code.visualstudio.com/docs/remote/containers).
-This setup allows you to develop within a Docker container that already has all
-the necessary tools and dependencies installed.
-
-The development container is based on Ubuntu 20.04 (Focal) and includes the
-following tools:
-
-- AWS CLI
-- Node.js
-- TypeScript
-- Docker CLI
-- Terraform
-
-### Prerequisites
-
-- [Docker](https://www.docker.com/products/docker-desktop) installed on your
-  local machine.
-- [Visual Studio Code](https://code.visualstudio.com/) installed on your
-  local machine.
-- [Remote - Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
-  for Visual Studio Code.
-
-### Usage
-
-1. Clone this repository:
-
-    ```bash
-    git clone https://github.com/sgtoj/terraform-docker-artifact-packager.git
-    ```
-
-2. Open the repository in Visual Studio Code:
-
-    ```bash
-    code terraform-docker-artifact-packager
-    ```
-
-3. When prompted to "Reopen in Container", click "Reopen in Container". This
-   will start building the Docker image for the development container. If you're
-   not prompted, you can open the Command Palette (F1 or Ctrl+Shift+P), and run
-   the "Remote-Containers: Reopen Folder in Container" command.
-
-4. After the development container is built and started, you can use the
-   Terminal in Visual Studio Code to interact with the container. All commands
-  you run in the Terminal will be executed inside the container.
-
-### Troubleshooting
-
-If you encounter any issues while using the development container, you can try
-rebuilding the container. To do this, open the Command Palette and run the
-"Remote-Containers: Rebuild Container" command.
+We welcome contributions to this project. For information on setting up a
+development environment and how to make a contribution, see [CONTRIBUTING](./CONTRIBUTING.md)
+documentation.