feat: PR and Issues template (#17)

* feat: PR and Issues template
* feat: structured ISSUE templates

Author: PyDataBlog

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug Report
+about: Create a report to help us improve
+title: 'bug: '
+labels: 'bug'
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Command-line arguments used: `...`
+2. Input data (if applicable): `...`
+3. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Error messages or logs**
+If applicable, add any error messages or logs to help explain your problem.
+
+**Environment (please complete the following information):**
+ - OS: [e.g. Ubuntu 20.04]
+ - simstring-rs version: [e.g. 0.1.0]
+ - Rust version: [e.g. 1.58.1]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/chore.md

@@ -0,0 +1,11 @@
+---
+name: Chore
+about: Other tasks
+title: 'chore: '
+labels: 'chore'
+assignees: ''
+
+---
+
+**Description**
+A clear and concise description of the task.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Ask a question
+    url: https://github.com/bebr/simstring_rs/discussions/new
+    about: Please ask and answer questions here.

.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,14 @@
+---
+name: Documentation Improvement
+about: Suggest an improvement for the documentation
+title: 'docs: '
+labels: 'documentation'
+assignees: ''
+
+---
+
+**Describe the improvement you'd like**
+A clear and concise description of what you want to happen.
+
+**Additional context**
+Add any other context or screenshots about the documentation improvement here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature Request
+about: Suggest an idea for this project
+title: 'feat: '
+labels: 'enhancement'
+assignees: ''
+
+---
+
+**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 [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,49 @@
+---
+name: Pull Request
+about: Propose a change to the project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Description**
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+**Fixes** (issue)
+
+**Type of change**
+
+Please choose the type of change that best describes your PR.
+
+- [ ] `fix(scope)`: A bug fix (non-breaking change which fixes an issue)
+- [ ] `feat(scope)`: A new feature (non-breaking change which adds functionality)
+- [ ] `feat!(scope)`: A breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] `docs(scope)`: This change requires a documentation update
+- [ ] `chore(scope)`: Other changes that don't modify src or test files
+- [ ] `refactor(scope)`: A code change that neither fixes a bug nor adds a feature
+- [ ] `perf(scope)`: A code change that improves performance
+- [ ] `test(scope)`: Adding missing tests or correcting existing tests
+- [ ] `style(scope)`: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+- [ ] `ci(scope)`: Changes to our CI configuration files and scripts
+- [ ] `revert(scope)`: Reverts a previous commit
+
+**How Has This Been Tested?**
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
+
+- [ ] Test A
+- [ ] Test B
+
+**Checklist:**
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] I have added an entry to the CHANGELOG.md file
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules

CHANGELOG.md

@@ -0,0 +1,34 @@
+## v0.1.3
+
+### Features
+
+- PR and Issues template
+
+### Other
+
+- added order indipendence test (#12)
+
+## v0.1.2
+
+### Features
+
+- Initial benchmark suite (#11)
+- Release: Initial benchmarks compared to other implementations in other languages (#13)
+
+## v0.1.1
+
+### Other
+
+- WIP: Initial proposed search method for hashdb (#7)
+
+## v0.1.0
+
+### Features
+
+- Initial API structure (#1)
+
+### Bug Fixes
+
+- keywords not exceeding 5 items (#3)
+- Added tag trigger to CI workflow (#2)
+

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "simstring_rust"
-version = "0.1.2"
+version = "0.1.3"
 description = "A native Rust implementation of the SimString algorithm"
 license = "MIT"
 repository = "https://github.com/PyDataBlog/simstring_rs"

Cargo.toml

@@ -17,7 +17,7 @@ impl FeatureExtractor for CharacterNGrams {
 
 fn pad_string(s: &str, padder: &str, n: usize) -> String {
     let pad = padder.repeat(n);
-    format!("{}{}{}", pad, s, pad)
+    format!("{pad}{s}{pad}")
 }
 
 fn init_char_ngrams(s: &str, n: usize) -> Vec<String> {