add files for contributing

Signed-off-by: Bryant Finney <[email protected]>

Author: bryant-finney

.gitlab/issue_templates/bug.md

@@ -0,0 +1,59 @@
+# Bug Report
+
+<!-- 1-3 sentences summarizing the bug you encountered -->
+
+## Steps to Reproduce
+
+<!--
+provide detailed steps to reproduce the bug. these steps will be used to write an acceptance test
+for the bug fix, so snippets of Python are welcome.
+-->
+
+1. Step 1
+2. Step 2
+3. Step 3
+4. ...
+
+### Expected Behavior
+
+<!-- what you expected to happen when following the steps above -->
+
+### Actual Behavior
+
+<!-- what actually happened when following the steps above -->
+
+## Environment
+
+<!-- provide information needed to reproduce the environment where the bug occurred -->
+
+```sh
+poetry env info
+```
+
+### Virtualenv
+
+- Python:
+- Implementation:
+- Path:
+- Executable:
+- Valid:
+
+### System
+
+- Platform:
+- OS:
+- Python:
+- Path:
+- Executable:
+
+## Additional Information
+
+<!-- any other information about the bug that you think might be helpful -->
+
+### Possible Solution
+
+<!-- if you have any ideas on how to solve the bug, please suggest them here -->
+
+### Related Issues
+
+<!-- are there any related issues? if yes, please list them here -->

.gitlab/issue_templates/feature.md

@@ -0,0 +1,29 @@
+# Feature Request
+
+<!-- 1-3 sentences describing the feature you would like to see implemented -->
+
+## User Story
+
+<!--
+describe the specific use case and users of this feature in the format of a user story
+
+for example:
+
+> As a cloud engineer, most of my configuration files are stored in AWS SSM Parameter Store. I would
+> like the ability for `pyspry` to retrieve these files automatically.
+-->
+
+### Proposed Solution
+
+<!--
+if you have any ideas or suggestions on how the feature could be implemented, please summarize them
+here, including any relevant code examples or concepts.
+-->
+
+## Additional Information
+
+<!-- any additional information that might help the developers evaluate your feature request -->
+
+### Related Issues
+
+<!-- are there any related issues? if yes, please list them here -->

CHANGELOG.md

@@ -0,0 +1,4 @@
+[![latest release](https://gitlab.com/bfosi/pyspry/-/badges/release.svg)](https://gitlab.com/bfosi/pyspry/-/releases)
+
+See for [the release history](https://gitlab.com/bfosi/pyspry/-/releases) for a log of the changes
+to this package.

CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing to `pyspry`
+
+Thank you for your interest in contributing to `pyspry`! We appreciate your help to make this
+project better.
+
+## Table of Contents
+
+- [Contributing to `pyspry`](#contributing-to-pyspry)
+  - [Table of Contents](#table-of-contents)
+  - [Code of Conduct](#code-of-conduct)
+  - [How Can I Contribute?](#how-can-i-contribute)
+    - [Reporting Bugs 🪲](#reporting-bugs-)
+    - [Suggesting Features / Enhancements ✨](#suggesting-features--enhancements-)
+    - [Merge Requests](#merge-requests)
+  - [Development Setup](#development-setup)
+  - [License](#license)
+
+## Code of Conduct
+
+Please note that by participating in this project, you are expected to adhere to the
+[Community Code of Conduct](https://about.gitlab.com/community/contribute/code-of-conduct/). Treat
+each other with respect to create a positive and inclusive environment. 🥳
+
+## How Can I Contribute?
+
+There are several ways you can contribute to `pyspry`!
+
+### Reporting Bugs 🪲
+
+If you encounter any bugs while using `pyspry`, please
+[open a new issue](https://gitlab.com/bfosi/pyspry/issues/new) using the
+[bug.md](.gitlab/issue_templates/bug.md) template.
+
+### Suggesting Features / Enhancements ✨
+
+If you have any ideas or suggestions to improve `pyspry`, please
+[open a new issue](https://gitlab.com/bfosi/pyspry/issues/new) using the
+[feature.md](.gitlab/issue_templates/feature.md) template.
+
+### Merge Requests
+
+Merge requests for bug fixes, enhancements, and new features are very welcome. To contribute code to
+`pyspry`, follow these steps:
+
+1. Create [a fork of the repository](https://gitlab.com/bfosi/pyspry/-/forks/new)
+2. Implement your changes in the fork, ensuring they adhere to the project's
+   [linters and formatters](.pre-commit-config.yaml)
+3. Open a new merge request from your fork to the `pyspry` repository, and provide a detailed
+   description of your changes.
+
+Note: each contribution must pass all CI/CD and linting tests in order to be considered.
+
+Once your pull request is submitted, it will be reviewed by the project maintainers. Please be
+patient, as it may take some time to receive feedback.
+
+## Development Setup
+
+Refer to the [README](README.md#development) for details on how to set up a development environment for
+`pyspry`.
+
+## License
+
+By contributing to `pyspry`, you agree that your contributions will be licensed under the project's
+[OSI approved license](LICENSE).

README.md

@@ -8,7 +8,7 @@
 [![PyPI version](https://badge.fury.io/py/pyspry.svg)](https://badge.fury.io/py/pyspry)
 [![Downloads](https://static.pepy.tech/badge/pyspry)](https://pepy.tech/project/pyspry)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![docs: pdoc](https://img.shields.io/badge/docs-pdoc-blueviolet)](https://bfosi.gitlab.io/pyspry/pyspry.html?logo=gitlab)
+[![docs: pdoc](https://img.shields.io/badge/docs-pdoc-blueviolet?logo=gitlab)](https://bfosi.gitlab.io/pyspry/pyspry.html)
 [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://bfosi.gitlab.io/pyspry/reports/mypy-html)
 
 Influenced by [Spring Boot's YAML configuration features](https://docs.spring.io/spring-boot/docs/1.1.0.M1/reference/html/boot-features-external-config.html#boot-features-external-config-yaml),