Merge 38e2a2c into 62fc975

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+
+---
+
+**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 '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**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]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+
+---
+
+**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,37 @@
+# Description
+
+Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] 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 not work as expected)
+- [ ] This change requires a documentation update
+
+# 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
+
+**Test Configuration**:
+* Toolchain:
+* SDK:
+
+# Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] 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
+

.github/workflows/build.yml

@@ -7,10 +7,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: "Maven Cache"
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ~/.m2/repository
           key: ${{ runner.os }}-cache-maven-${{ hashFiles('**/pom.xml') }}
@@ -21,7 +21,7 @@ jobs:
           java-version: 11
 
       - name: "Maven Test"
-        run: mvn clean test jacoco:report coveralls:report -DdryRun=true
+        run: mvn clean test jacoco:report coveralls:report -DdryRun=true -Pbuddy
 
       - name: "Send to Coveralls (build java-${{ github.run_number }})"
         uses: MikeEdgar/github-action@raw_coverage_file
@@ -31,7 +31,7 @@ jobs:
           coverage-format: raw
 
       - name: "Deploy GH-Pages"
-        if: github.ref == 'refs/heads/master' && github.event_name == 'push'
+        if: github.ref == 'refs/heads/main' && github.event_name == 'push'
         uses: JamesIves/github-pages-deploy-action@3.7.1
         with:
           github_token: ${{ secrets.github_token }}

.gitignore

@@ -1,12 +1,70 @@
-.apt_generated/
-target/
-.DS_Store
+### Git ###
+!.gitkeep
+
+
+### STS ###
+.apt_generated
 .classpath
 .factorypath
 .project
 .settings
 .springBeans
-.vscode
-bin/
+.sts4-cache
+
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+
+/.nb-gradle/
+
+
+### VS Code ###
+.vscode/
+
+dump.rdb
+
+
+### OS Specific ###
+.DS_Store
+.tmp/
+
+tmp/
+
+
+### Maven ###
 logs/
-*.log*
+target/
+
+.classpth
+.mvn/timing.properties
+.mvn/wrapper/maven-wrapper.jar
+.project
+
+buildNumber.properties
+dependency-reduced-pom.xml
+pom.xml.next
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+release.properties
+
+
+### Weaver ###
+dist/
+
+
+### Project Specific ###
+.env*
+
+!**/src/main/**
+!**/src/test/**

CONTRIBUTING.md

@@ -0,0 +1,64 @@
+<a name="readme-top"></a>
+# Contributing to Project Management Service
+
+Though *Project Management Service* is developed and maintained by Texas A&M University Libraries, we welcome community contributions.
+Involvement in *Project Management Service* can take many forms.
+
+<div align="right">(<a href="#readme-top">back to top</a>)</div>
+
+
+## Using
+
+Deploying *Project Management Service* and trying it out at your own institution is itself a way of contributing to the development process.
+For more information on deployment strategies please see the [Deployment Guide][deployment-guide].
+
+<div align="right">(<a href="#readme-top">back to top</a>)</div>
+
+
+## Filing Issues
+
+Once you are using *Project Management Service* the creation of new issues through GitHub is a major method of contribution towards *Project Management Service* development.
+Issues can be motivated by the discovery of a bug in the software, or by the desire to see either new features added or see changes to existing features.
+
+There are two primary types of issues:
+1. Bug Report
+2. Feature Request
+
+A **Bug Report** involves a problem with the existing software or a **Feature** is not working as designed or expected.
+
+A **Feature** involves new functionality or behavior.
+
+<div align="right">(<a href="#readme-top">back to top</a>)</div>
+
+
+## Creating a Pull Request
+
+Community code and documentation contributions are welcome and should take the form of a **GitHub Pull Request** (*PR*).
+Each *PR* will need to be reviewed by a *Project Management Service* developer.
+A review will result in the *PR* being accepted and merged, a descriptive request for changes, or the *PR* being closed along with a detailed explanation.
+
+It is our intention to maintain labeling on issues that are deemed to be low difficulty in order to provide a good point of entry for those looking to begin contributing code or documentation.
+
+A *PR* description should include a list of the specific issues resolved, the predicted *semantic versioning* impact of the changes, and a description which characterizes the nature of the changes made.
+When creating a *PR*, an issue template is automatically provided to simplify this process.
+
+For more information about *semantic versioning* please see [Semantic Versioning Website][semantic-versioning].
+In general keep in mind:
+
+- A **Major Change** is a breaking change that is not backwards compatible.
+- A **Minor Change** is a non-breaking change that is backwards compatible to the last **Major Change**.
+- A **Patch** is a trivial change or bug fix that should not impact compatibility.
+
+<div align="right">(<a href="#readme-top">back to top</a>)</div>
+
+
+## Good Luck!
+
+We look forward to seeing your contributions.
+If you have any additional questions please contact the *Project Management Service* developers at helpdesk@library.tamu.edu.
+
+<div align="right">(<a href="#readme-top">back to top</a>)</div>
+
+<!-- LINKS -->
+[deployment-guide]: DEPLOYING.md
+[semantic-versioning]: https://semver.org/

DEPLOYING.md

@@ -0,0 +1,67 @@
+<a name="readme-top"></a>
+# Project Management Service Deployment Guide
+
+## Production Deployments
+
+For **production** deployments, deploy using `docker-compose` via the [Project App Repo][app-repo].
+This is the recommended method of deployment for production systems.
+Go to the [Project Management App Repo][app-repo] and following the deployment instructions there.
+
+Performing the deployment using the [Project Management App Repo][app-repo] should be something similar to the following:
+```shell
+docker-compose up
+```
+
+The **development** deployment can also use `docker-compose` in the same way.
+
+<div align="right">(<a href="#readme-top">back to top</a>)</div>
+
+
+## Development Deployment using Docker
+
+To manually use `docker` rather than `docker-compose`, run the following:
+
+```shell
+docker image build -t projectservice .
+docker run -it projectservice
+```
+
+<sub>_* Note: `-t projectservice` and `-it projectservice` may be changed to another tag name as desired, such as `-t developing_on_this` and `-it developing_on_this`._</sub><br>
+
+<div align="right">(<a href="#readme-top">back to top</a>)</div>
+
+
+## Development Deployment using Maven
+
+Manual deployment can be summed up by running:
+
+```shell
+mvn spring-boot:run
+```
+
+Those steps are a great way to start but they also fail to explain the customization that is often needed.
+There are multiple ways to further configure this for deployment to better meet the desired requirements.
+
+It is highly recommended only to perform *manual installation* when developing.
+For **production** deployment, please use `docker-compose` via the [Project Management App Repo][app-repo] or use the **Docker** method above.
+
+<div align="right">(<a href="#readme-top">back to top</a>)</div>
+
+
+### Directly Configuring the `src/main/resources/application.yml` File
+
+This method of configuration works by altering the configuration file.
+
+With this in mind, the deployment steps now look like:
+
+```shell
+# Edit 'src/main/resources/application.yml' here.
+
+mvn spring-boot:run
+```
+
+<div align="right">(<a href="#readme-top">back to top</a>)</div>
+
+
+<!-- LINKS -->
+[app-repo]: https://github.com/TAMULib/ProjectManagement