Merge pull request #88 from robbievanleeuwen/dev

Code modernisation

.darglint

@@ -0,0 +1,3 @@
+[darglint]
+strictness = full
+ignore_regex=^test_(.*)

.flake8

@@ -0,0 +1,8 @@
+[flake8]
+select = B,B9,C,D,DAR,E,F,N,RST,S,W
+ignore = B028,B905,E203,E501,E741,RST201,RST203,RST301,RST303,W503
+max-line-length = 80
+docstring-convention = google
+per-file-ignores = tests/*:S101,__init__.py:F401,post.py:C901
+rst-roles = class,const,func,meth,mod,ref
+rst-directives = deprecated

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,35 +1,34 @@
 ---
-name: Bug report
-about: Create a report to help us improve
-
+name: "🐛 Bug Report"
+about: Did you find a bug?
+labels: bug
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+<!--
+    Hi there! Thank you for submitting a bug report!
+
+    Before you submit your issue, please review and follow the instructions at
+    https://github.com/robbievanleeuwen/concrete-properties/blob/master/CONTRIBUTING.md#How-to-report-a-bug.
+    Fully fill out the template below; insufficient information or bad reproduction
+    instructions will impair the ability of others to help you.
+-->
 
-**To Reproduce**
-Steps to reproduce the behaviour:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+<!-- All the below information must be provided for others to understand and help with your issue. -->
 
-**Expected behaviour**
-A clear and concise description of what you expected to happen.
+- **concreteproperties version**: <!-- Replace with version, e.g. from `concreteproperties --version` -->
+- **Python version**: <!-- Replace with the version of Python being used to run concreteproperties -->
+- **OS version and name**: <!-- Replace with version + name, e.g. Ubuntu 22.04 or macOS 12.6 -->
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+<!-- All the below steps should be completed before submitting your issue. Checked checkbox should look like this: [x] -->
 
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+- [ ] I am on the [latest](https://github.com/robbievanleeuwen/concrete-properties/releases/latest)
+      stable concreteproperties version, installed using a recommended method.
+- [ ] I have searched the [issues](https://github.com/robbievanleeuwen/concrete-properties/issues)
+      of this repo and believe that this is not a duplicate.
+- [ ] I have consulted the [documentation](https://concreteproperties.readthedocs.io/)
+      for any relevant information.
 
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+## Issue
 
-**Additional context**
-Add any other context about the problem here.
+<!-- Now feel free to write your issue, and please be as descriptive as possible! Make sure to include detailed reproduction steps and compare to expected behaviour. -->
+<!-- Thanks again 🙌 ❤ -->

.github/ISSUE_TEMPLATE/config.yaml

@@ -0,0 +1,6 @@
+blank_issues_enabled: false
+contact_links:
+  - name: "💬 Discussions"
+    url: https://github.com/robbievanleeuwen/concrete-properties/discussions
+    about: |
+      Ask questions about using concreteproperties, concreteproperties's features and roadmap, or get support and feedback for your usage of concreteproperties.

.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,25 @@
+---
+name: "📚 Documentation Issue"
+about: Did you find errors, omissions, or anything unintelligible in the documentation?
+labels: documentation
+---
+
+<!--
+    Hi there! Thank you for helping improve our documentation!
+
+    Before you submit your issue, please make sure you have completed the checklist
+    below.
+-->
+
+<!--
+    All the below steps should be completed before submitting your issue. Checked
+    checkbox should look like this: [x]
+-->
+
+- [ ] I have searched the [issues](https://github.com/robbievanleeuwen/concrete-properties/issues)
+      of this repo and believe that this is not a duplicate.
+
+## Issue
+
+<!-- Now feel free to write your issue, and please be as descriptive as possible! -->
+<!-- Thanks again 🙌 ❤ -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,17 +1,27 @@
 ---
-name: Feature request
-about: Suggest an idea for this project
-
+name: "✨ Feature Request"
+about: Do you have ideas for new features or improvements?
+labels: enhancement
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+<!--
+    Hi there! Thank you for submitting a feature request!
+
+    Before you submit your issue, please review and follow the instructions at
+    https://github.com/robbievanleeuwen/concrete-properties/blob/master/CONTRIBUTING.md#How-to-request-a-feature.
+-->
+
+<!--
+    All the below steps should be completed before submitting your issue. Checked
+    checkbox should look like this: [x]
+-->
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+- [ ] I have searched the [issues](https://github.com/robbievanleeuwen/concrete-properties/issues)
+      of this repo and believe that this is not a duplicate.
+- [ ] I have searched the [documentation](https://concreteproperties.readthedocs.io/) and
+      believe that my question is not already covered.
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+## Feature Request
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+<!-- Now feel free to write your issue, and please be as descriptive as possible! -->
+<!-- Thanks again 🙌 ❤ -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,15 @@
+# Pull Request Check List
+
+Resolves: #issue-number-here
+
+<!-- This is just a reminder about the most common mistakes. Please make sure that you
+tick all *appropriate* boxes.  But please read our
+[contribution guide](https://github.com/robbievanleeuwen/concrete-properties/blob/master/CONTRIBUTING.md)
+at least once, it will save you unnecessary review cycles! -->
+
+- [ ] Added **tests** for changed code.
+- [ ] Updated **documentation** for changed code.
+- [ ] Run the **Nox** test suite to check for errors and warnings.
+
+<!-- If you have *any* questions to *any* of the points above, just **submit and ask**!
+This checklist is here to *help* you, not to deter you from contributing! -->

.github/labels.yml

@@ -0,0 +1,94 @@
+---
+# Labels names are important as they are used by Release Drafter to decide
+# regarding where to record them in changelog or if to skip them.
+#
+# The repository labels will be automatically configured using this file and
+# the GitHub Action https://github.com/marketplace/actions/github-labeler.
+
+- name: breaking
+  description: Breaking Changes
+  color: bfd4f2
+
+- name: bug
+  description: Something isn't working
+  color: d73a4a
+
+- name: build
+  description: Build System and Dependencies
+  color: bfdadc
+
+- name: ci
+  description: Continuous Integration
+  color: 4a97d6
+
+- name: dependencies
+  description: Pull requests that update a dependency file
+  color: 0366d6
+
+- name: documentation
+  description: Improvements or additions to documentation
+  color: 0075ca
+
+- name: engineering
+  description: Issue related to engineering methods/assumptions
+  color: e8d52c
+
+- name: duplicate
+  description: This issue or pull request already exists
+  color: cfd3d7
+
+- name: enhancement
+  description: New feature or request
+  color: a2eeef
+
+- name: github_actions
+  description: Pull requests that update Github_actions code
+  color: "000000"
+
+- name: good first issue
+  description: Good for newcomers
+  color: 7057ff
+
+- name: help wanted
+  description: Extra attention is needed
+  color: 33aa3f
+
+- name: invalid
+  description: This doesn't seem right
+  color: e4e669
+
+- name: performance
+  description: Performance
+  color: "016175"
+
+- name: python
+  description: Pull requests that update Python code
+  color: 2b67c6
+
+- name: question
+  description: Further information is requested
+  color: d876e3
+
+- name: refactoring
+  description: Refactoring
+  color: ef67c4
+
+- name: removal
+  description: Removals and Deprecations
+  color: 9ae7ea
+
+- name: style
+  description: Style
+  color: c120e5
+
+- name: testing
+  description: Testing
+  color: b1fc6f
+
+- name: wontfix
+  description: This will not be worked on
+  color: ffffff
+
+- name: stale
+  description: This issue hasn't received enough love
+  color: 922A20

.github/release-drafter.yml

@@ -0,0 +1,65 @@
+categories:
+  - title: ":boom: Breaking Changes"
+    label: "breaking"
+
+  - title: ":rocket: Features"
+    label: "enhancement"
+
+  - title: ":fire: Removals and Deprecations"
+    label: "removal"
+
+  - title: ":bug: Fixes"
+    label: "bug"
+
+  - title: ":racehorse: Performance"
+    label: "performance"
+
+  - title: ":rotating_light: Testing"
+    label: "testing"
+
+  - title: ":construction_worker: Continuous Integration"
+    label: "ci"
+
+  - title: ":books: Documentation"
+    label: "documentation"
+
+  - title: ":hammer: Refactoring"
+    label: "refactoring"
+
+  - title: ":lipstick: Style"
+    label: "style"
+
+  - title: ":package: Dependencies"
+    labels:
+      - "dependencies"
+      - "build"
+
+category-template: "### $TITLE"
+
+version-resolver:
+  major:
+    labels:
+      - "major"
+  minor:
+    labels:
+      - "minor"
+  patch:
+    labels:
+      - "patch"
+  default: patch
+
+exclude-contributors:
+  - "robbievanleeuwen"
+
+# Custom text at start of release
+header: |
+  xxx
+
+template: |
+  ## What's Changed
+
+  $CHANGES
+
+footer: |
+
+  **Full changelog:** [$PREVIOUS_TAG...v$RESOLVED_VERSION](https://github.com/robbievanleeuwen/concrete-properties/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION)