docs: CONTRIBUTING.md, CODE_OF_CONDUCT.md, README badges, PULL_REQUES…

…T_TEMPLATE.md

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,30 @@
+<!--                READ THE CONTRIBUTING GUIDELINES                 -->
+<!-- https://github.com/adamperkowski/nvrs/blob/main/CONTRIBUTING.md -->
+
+# [TITLE]
+
+## Description
+<!--- Describe your changes in detail -->
+
+## Context
+<!-- Why is this change required? What problem does it solve? -->
+<!--     If it fixes an open issue, please link it below.     -->
+<!-- Example:
+- Resolves #1 -->
+
+## Testing
+<!-- Please describe how you tested your changes in detail. -->
+
+## Screenshots / Logs (if applicable)
+
+## Checklist
+<!-- Go over all the following points, put an `x` in all the boxes that apply. -->
+- [ ] My code adheres to the coding and style guidelines of the project.
+- [ ] I have performed a self-review of my own code.
+- [ ] I have commented my code, particularly in hard-to-understand areas.
+- [ ] I made corresponding changes to the documentation.
+- [ ] I formatted the code with [rustfmt](https://github.com/rust-lang/rustfmt).
+- [ ] I checked the lints with [clippy](https://github.com/rust-lang/rust-clippy).
+- [ ] I generated the changelog with [git-cliff](https://github.com/orhub/git-cliff).
+
+<!-- Thank you for contributing! -->

CODE_OF_CONDUCT.md

@@ -0,0 +1,14 @@
+# nvrs Code of Conduct
+**Contact:** [adas1per@protonmail.com](mailto:adas1per@protonmail.com)
+
+## Conduct
+* We are committed to providing a friendly, safe and welcoming environment for all, regardless of anything.
+* Please be kind, friendly and active - don't abandon your work without communicating.
+* Respect different perspectives and opinions. Be tolerant of opposing views, disagreements should be addressed with respect and courtesy.
+* Any spamming, trolling, flaming, baiting or other attention-stealing behavior is not welcome.
+
+## Moderation
+These are the policies for upholding our community's standards of conduct. If you feel that a thread needs moderation, please contact me (email above) or other [CODE OWNERS](https://github.com/adamperkowski/highlightos/blob/main/.github/CODEOWNERS).
+
+## Attribution
+This Code of Conduct is inspired by [The Rust Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct).

CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing
+
+Thank you for considering contributing to [nvrs](https://github.com/adamperkowski/nvrs) ❤️
+
+Note that we have a [Code of Conduct](./CODE_OF_CONDUCT.md). Please follow it in all your interactions with the project.
+
+## Workflow
+
+1. Fork this repository and create your branch from `main`.
+
+2. Clone your forked repository.
+
+```sh
+git clone https://github.com/adamperkowski/nvrs && cd nvrs
+# OR
+git clone git@github.com:adamperkowski/nvrs && cd nvrs
+```
+
+3. Make sure that you have [Rust](https://rust-lang.org) installed and build the project.
+
+```sh
+cargo build
+```
+
+4. Start committing your changes. Follow the [conventional commit specification](https://conventionalcommits.org).
+
+5. Make sure [rustfmt](https://github.com/rust-lang/rustfmt) and [clippy](https://github.com/rust-lang/rust-clippy) don't complain about your changes.
+
+6. If needed, update the changelog. Make sure that you have [git-cliff](https://github.com/orhun/git-cliff) installed.
+
+```sh
+git-cliff > CHANGELOG.md
+git add CHANGELOG.md
+git commit -m "changelog for $(git rev-parse --short HEAD)"
+```
+
+## Submitting Changes
+
+1. Ensure that you updated the documentation and filled the [Pull Request template](./.github/PULL_REQUEST_TEMPLATE.md) according to the changes you made.
+
+2. Push the changes and [open a Pull Request](https://github.com/adamperkowski/nvrs/pull/new).
+
+3. Wait for review from the project's [CODE OWNER](./.github/CODEOWNERS). Update the Pull Request accordingly.
+
+4. Once the Pull Request is approved, it will be merged into the main branch.
+
+<!--         The above guidelines were inspired by git-cliff's CONTRIBUTING.md          -->
+<!--          Copyright (c) 2021-2024 Orhun Parmaksız, git-cliff contributors           -->
+<!-- https://github.com/orhun/git-cliff/commit/2e65a72bb044bad94f2568c491e4907f92331a56 -->

README.md

@@ -4,6 +4,8 @@
 new version checker for software releases 🦀<br>
 [nvchecker](https://github.com/lilydjwg/nvchecker) rewritten in Rust
 
+![GitHub Contributors](https://img.shields.io/github/contributors-anon/adamperkowski/nvrs?style=for-the-badge&labelColor=%23a8127d&color=%23336795) ![GitHub Repo Size](https://img.shields.io/github/repo-size/adamperkowski/nvrs?style=for-the-badge&labelColor=%23a8127d&color=%23336795) ![Repo Created At](https://img.shields.io/github/created-at/adamperkowski/nvrs?style=for-the-badge&labelColor=%23a8127d&color=%23336795)
+
 ![banner](/banner.png)
 
 </div>