Merge pull request #114 from the-dotify-project/development

Development

Author: billsioros

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -1,6 +1,6 @@
 name: 🐞 Bug Report
 description: Did you find a bug?
-title: "🐞: "
+title: "🐞 "
 labels: [":bug: bug"]
 assignees:
   - billsioros
@@ -33,15 +33,18 @@ body:
       label: Relevant stack trace
       description: Please provide us with the program's stack trace, if appropriate.
       render: shell
-  - type: checkboxes
-    id: operating-systems
+  - type: dropdown
+    id: operating-system
     attributes:
-      label: Which operating systems have you used?
-      description: You may select more than one.
+      label: Operating System (OS)
+      multiple: true
+      description: In what OS(s) does the problem occur?
       options:
-        - label: macOS
-        - label: Windows
-        - label: Linux
+        - macOS
+        - Windows
+        - Linux
+    validations:
+      required: true
   - type: dropdown
     id: python-version
     attributes:

.github/ISSUE_TEMPLATE/docs.yaml

@@ -1,6 +1,6 @@
 name: 📄 Documentation
 description: Suggest a change regarding this project's documentation
-title: "📄: "
+title: "📄 "
 labels: [":memo: documentation"]
 assignees:
   - billsioros

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -1,6 +1,6 @@
 name: 🎁 Feature Request
 description: Suggest a feature or improvement
-title: "🎁: "
+title: "🎁 "
 labels: [":bulb: feature request"]
 assignees:
   - billsioros

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,36 +1,18 @@
-<!--- Provide a general summary of your changes in the Title above -->
-
 ## Description
-<!--- Describe your changes in detail -->
 
-## Related Issue
-<!--- This project only accepts pull requests related to open issues -->
-<!--- If suggesting a new feature or change, please discuss it in an issue first -->
-<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
-<!--- Please link to the issue here: -->
+<!-- Please provide a concise description of your changes, as well as the reasoning behind them. -->
 
-## Motivation and Context
-<!--- Why is this change required? What problem does it solve? -->
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+
+- [ ] I have updated the documentation accordingly.
+- [ ] I have added tests to cover my changes.
 
-## How Has This Been Tested?
-<!--- Please describe in detail how you tested your changes. -->
-<!--- Include details of your testing environment, and the tests you ran to -->
-<!--- see how your change affects other areas of the code, etc. -->
+---
 
-## Screenshots (if appropriate):
+## Related Issue
 
-## Types of changes
-<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+<!--- This project only accepts pull requests related to open issues -->
+<!--- If suggesting a new feature or change, please discuss it in an issue first -->
+<!--- If fixing a bug, there should be an issue describing it along with reproduction steps -->
 
-## Checklist:
-<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
-<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
-- [ ] My code follows the code style of this project.
-- [ ] My change requires a change to the documentation.
-- [ ] I have updated the documentation accordingly.
-- [ ] I have read the project's [contributing guidelines](/docs/CONTRIBUTING.md).
-- [ ] I have added tests to cover my changes.
-- [ ] All new and existing tests passed.
+Closes #issue-number-here.

CHANGELOG.md

@@ -2,8 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). See [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit guidelines.
 
 <!--next-version-placeholder-->
 

docs/CONTRIBUTING.md

@@ -23,7 +23,7 @@ Contributions are made to this repository via Issues and Pull Requests (PRs). A
 
 ### Issues
 
-Issues should be used to report problems with the library or request a new feature or documentation change. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the required information.
+[Issues](https://github.com/the-dotify-project/dotify/issues) should be used to report problems with the library or request a new feature or documentation change. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the required information.
 
 If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a [reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) can also help in indicating to our maintainers that a particular problem is affecting more than just the reporter.
 
@@ -37,8 +37,8 @@ PRs can be a quick way to get your fix or improvement slated for the next releas
 - Add [unit or integration tests](https://github.com/the-dotify-project/dotify/tree/master/examples) for added or changed functionality.
 - Any code related changes should be accompanied by corresponding changes to the project's documentation.
 - If your pull request introduces a new feature, the corresponding `README` [section](https://the-dotify-project.github.io/dotify/latest/#features) must be updated to reflect this. Make sure you also include [an example](https://github.com/the-dotify-project/dotify/tree/master/examples), showcasing this new functionality.
-- Write clear, concise commit message(s) using [conventional-changelog format](https://github.com/conventional-changelog/conventional-changelog-angular/blob/master/convention.md). [Why?](#writing-your-commit-message)
-- If your PR is connected to an open issue, add a line in your PR's description that says `Fixes: #123`, where `#123` is the number of the issue you're fixing.
+- Write clear, concise commit message(s) using the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format. [Why?](#writing-your-commit-message)
+- This project only accepts pull requests related to open issues. In case there is no relevant open issue, feel free to [create one](https://github.com/the-dotify-project/dotify/issues/new/choose).
 
 For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.
 
@@ -111,7 +111,7 @@ Having made your changes, please run `mkdocs server` and make sure that no error
 
 ### Writing your commit message
 
-The project's version number and [Changelog](https://github.com/the-dotify-project/dotify/blob/master/CHANGELOG.md), depend on a consistent commit history. As a result, your commit message's format is extremely important. Before opening a pull request, please make sure that your commits strictly follow the [conventional-changelog format](https://github.com/conventional-changelog/conventional-changelog-angular/blob/master/convention.md).
+The project's version number and [Changelog](https://github.com/the-dotify-project/dotify/blob/master/CHANGELOG.md), depend on a consistent commit history. As a result, your commit message's format is extremely important. Before opening a pull request, please make sure that your commits strictly follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format].
 
 ### Creating a pull request