Merge pull request #2 from GaryHilares/develop

Improved templates, added changelog and added CMake project version

Author: GaryHilares

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,17 +1,17 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -20,19 +20,16 @@ Steps to reproduce the behavior:
 **Expected behavior**
 A clear and concise description of what you expected to happen.
 
+**Actual behavior**
+A clear and concise description of what actually happened.
+
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**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]
+
+-   OS: [e.g. iOS]
+-   Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,2 +1,23 @@
-# Describe all your changes concisely.
-# Use bullets to separate your changes.
+# Changelog
+
+<!-- Add a changelog of the PR's changes, similar to the format of https://keepachangelog.com/en/1.1.0/  -->
+<!-- Delete sections of the changelog if unused -->
+
+Added:
+
+-   ...
+
+Modified:
+
+-   ...
+
+Removed:
+
+-   ...
+
+# Related issues
+
+<!-- Describe the issue that this PR is related to -->
+
+-   Solves issue #...
+-   Makes progress on issue #...

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+Format based on [Keep a Changelog v1.1.0](https://keepachangelog.com/en/1.1.0/).
+This project follows [Semantic Versioning v2.0.0](https://semver.org/spec/v2.0.0.html).
+
+## 1.0.0
+
+### Added
+
+-   RubberInt class for arbitrarily-sized integer support.
+-   RubberFloat class for arbitrarily-sized fixed-point decimal number support.

CMakeLists.txt

@@ -1,12 +1,16 @@
-# Based on GoogleTest quickstart guide: http://google.github.io/googletest/quickstart-cmake.html
 cmake_minimum_required(VERSION 3.14)
-project(my_project)
+project(RubberNumbers VERSION 1.0.0)
 
 # General C++ standard config
 # Note: GoogleTest requires at least C++14
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
+# Default value for BUILD_TYPE variable
+if(NOT BUILD_TYPE)
+  set(BUILD_TYPE "release")
+endif()
+
 # Target specific config
 if(BUILD_TYPE STREQUAL "testing")
   set(CMAKE_BUILD_TYPE "Debug")
@@ -47,6 +51,7 @@ FetchContent_MakeAvailable(googletest)
 
 # Compile and link if necessary
 if (INCLUDE_TESTS)
+    # Based on GoogleTest quickstart guide: http://google.github.io/googletest/quickstart-cmake.html
     enable_testing()
     add_executable(rubber_numbers src/tests.cpp src/RubberNumbers/RubberIntegers.cpp)