From 1cf0ce157baf6afd1ec7dd40dc577e342bbe7d75 Mon Sep 17 00:00:00 2001
From: Connor Mulligan <54652291+MisterC500@users.noreply.github.com>
Date: Tue, 17 Sep 2024 09:43:33 -0700
Subject: [PATCH] docs: add contributing docs (#39)

* docs: add contributing docs

* fix: remove pre-commit config, add conventional commit blurb in contributing doc
---
 .pre-commit-config.yaml | 44 ------------------------------------
 CONTRIBUTING.md         | 49 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 49 insertions(+), 44 deletions(-)
 delete mode 100644 .pre-commit-config.yaml
 create mode 100644 CONTRIBUTING.md

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
deleted file mode 100644
index 96a94a8..0000000
--- a/.pre-commit-config.yaml
+++ /dev/null
@@ -1,44 +0,0 @@
-default_install_hook_types: [pre-commit, pre-push, commit-msg]
-# See https://pre-commit.com for more information
-# See https://pre-commit.com/hooks.html for more hooks
-repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
-    hooks:
-      - id: check-added-large-files
-      - id: check-merge-conflict
-      - id: check-symlinks
-      - id: check-yaml
-        args:
-          - "--allow-multiple-documents"
-      - id: end-of-file-fixer
-      - id: mixed-line-ending
-      - id: trailing-whitespace
-  - repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: v0.41.0
-    hooks:
-      - id: markdownlint
-        exclude: CHANGELOG.md
-        args:
-          - "--fix" # Automatically fix issues
-          - "--disable=MD013" # Ignore Line length
-          - "--disable=MD033" # Allow Inline HTML
-          - "--disable=MD034" # Allow bare URLs
-  - repo: https://github.com/commitizen-tools/commitizen
-    rev: v3.29.0
-    hooks:
-      - id: commitizen
-      - id: commitizen-branch
-        stages: [push]
-  - repo: https://github.com/adrienverge/yamllint
-    rev: v1.35.1
-    hooks:
-      - id: yamllint
-        args:
-          - "-d"
-          - "{extends: relaxed, rules: {line-length: {max: 120}}}"
-  - repo: https://github.com/streetsidesoftware/cspell-cli
-    rev: v8.13.3
-    hooks:
-      - id: cspell
-        exclude: CHANGELOG.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..a7f78b3
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,49 @@
+# Contributing to the Liatrio Dora API Project
+
+Thank you for considering contributing to our Rust project! We're excited to have you on board.
+
+## Code of Conduct
+
+We follow the standard open-source code of conduct. Please be respectful and considerate in your interactions with the community.
+
+## Getting Started
+
+Before you start contributing, please make sure you have the following:
+
+* Rust and Cargo installed. You can install them from [rustup.rs](https://rustup.rs/).
+* A code editor or IDE of your choice, such as Visual Studio Code with the Rust extension.
+
+## Coding Style and Practices
+
+We follow standard Rust coding practices. Please make sure to:
+
+* Use `rustfmt` to format your code. You can run it with `cargo fmt`.
+* Use `clippy` to lint your code. You can run it with `cargo clippy`.
+* Use clear and descriptive variable names.
+* Use functions and modules to organize your code.
+* Keep your code concise and readable.
+* Use Rustdoc comments to document your code.
+
+## Testing
+
+We use Rust's built-in testing framework. Please make sure to write tests for any new features or bug fixes you contribute. You can run the tests with `cargo test`.
+
+## Opening Pull Requests
+
+To contribute to the codebase, please follow these steps:
+
+1. Fork the repository and create a new branch for your feature or bug fix.
+2. Run `cargo build` to build the project and ensure there are no compilation errors.
+3. Run `cargo fmt` and `cargo clippy` to format and lint your code.
+4. Run `cargo test` to ensure all tests pass.
+5. Use [Conventional Commits](https://www.conventionalcommits.org) to format your commit messages.
+6. Commit your changes and push your branch to your fork.
+7. Open a pull request with a clear description of your changes.
+
+Thank you for your contributions!
+
+## Review Process
+
+Once you've opened a pull request, it will be reviewed by the maintainers. We'll provide feedback and guidance to help you improve your contribution.
+
+Thank you again for contributing to the Liatrio Dora API!
\ No newline at end of file