refactor: maintainability improvements

[carlocorradini]

This PR makes a few changes to the repository to make it easier to manage and/or utilize generally:

Changes

• Added Dependabot Automatically monitor and fix vulnerable dependencies
• Added CODEOWNERS File to define individuals or teams that are responsible for code in a repository
• Better CI/CD (see .github/workflows)
• Added clippy A collection of lints to catch common mistakes and improve your Rust code. See lints in Cargo.toml Some code has been refactored (no breaking changes) to fix all lints
• Added .vscode directory
  • Added extensions.json file Workspace recommended extensions
  • Added settings.json Workspace settings
• Added EditorConfig maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs
• Added .gitattributes Defining attributes per path
• Better .gitignore
• Cargo.lock should be ignored in libraries (added in .gitignore)
• Fixed some typos
• Better README.md (all *.md files in general) with better badges.

Let me know what you think 🤗🥳🤯

[obmarg]

Thanks @carlocorradini but you really should have checked before going to the effort of putting this together.

I don't have the time to reply to each individual change just now, but most of these changes are not things I want.

[carlocorradini]

@obmarg Don't worry 🤗 It didn't take me that much 🙌 Tell me what you don't like/want and I'll refactor the PR 😊👌

[carlocorradini]

Sorry for the late reply; I'll fix them as soon as possible.

[carlocorradini]

.gitattributes file is a common one that I use in all my projects and comes from the gitattributes repository. The file is very useful to have a common/shared knowledge of line terminator to avoid possible commit changes across different environments (Widnows, Apple, Linux, ...)

[carlocorradini]

Cargo.lock should NOT be committed. See official issue. Moreover, when you create a new library project the .gitignore file already contains Cargo.lock with a comment that it should be ignored if this is a library whereas maintained if this is a binary.

[carlocorradini]

For all markdown files I've fixed some blanks that have been left and checked the formatting/styling with markdownlint (i.e. added a blank between a title and text). Moreover, fixed NewIssue in CONTRIBUTING.md

[obmarg]

Cargo.lock should NOT be committed. See official issue. Moreover, when you create a new library project the .gitignore file already contains Cargo.lock with a comment that it should be ignored if this is a library whereas maintained if this is a binary.

First off - it doesn't really matter what a cargo issue from 2014 says. It's my project and I want to commit Cargo.lock.

Secondly, this has not been the official stance for coming up to a year.

Third, that is not the behaviour for a new library project:

[carlocorradini]

@obmarg Awesome 🥳 I didn't know about that blog post 🤗

[carlocorradini]

@obmarg Everything should be fixed now 🤗🥳

[carlocorradini]

@obmarg Done 😊

[carlocorradini]

Done 👍