diff --git a/.github/ESLINT_RULES.md b/.github/ESLINT_RULES.md index 13c6f52..c3a91f7 100644 --- a/.github/ESLINT_RULES.md +++ b/.github/ESLINT_RULES.md @@ -1,6 +1,6 @@ # `ESLint` rules -`spring-boot-starter-thymeleaf` enforces the following code standards with `ESLint`. +`mvn-spring-boot-thymeleaf-nodejs` enforces the following code standards with `ESLint`. ## Table of contents diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index d049feb..ef1d205 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -42,7 +42,7 @@ In order to {achieve value}. ## 🐞 5. Your environment (for defects only) > ⌦ Include as many relevant details about the environment in which the defect occured. -* Version of `spring-boot-starter-thymeleaf`: +* Version of `mvn-spring-boot-thymeleaf-nodejs`: * Environment name and version (e.g. Chrome 39, node.js 5.4): * Operating System and version (desktop or mobile): * Link to your project: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3c9333b..fb7dff2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -48,8 +48,8 @@ replace this line and the following task completion line._ [checkstyle-google-url]: http://checkstyle.sourceforge.net/google_style.html [checkstyle-image]: ../docs/img/icon-checkstyle.png -[coveralls-img]: https://coveralls.io/repos/github/gregswindle/spring-boot-starter-thymeleaf/badge.svg -[coveralls-url]: https://coveralls.io/github/gregswindle/spring-boot-starter-thymeleaf +[coveralls-img]: https://coveralls.io/repos/github/gregswindle/mvn-spring-boot-thymeleaf-nodejs/badge.svg +[coveralls-url]: https://coveralls.io/github/gregswindle/mvn-spring-boot-thymeleaf-nodejs [sonar-code-smells-img]: http://sonarcloud.io/api/badges/measure?key=gregswindle-github&metric=code_smells [sonar-code-smells-url]: https://sonarcloud.io/component_measures/metric/code_smells/list?id=gregswindle-github&metric=code_smells [sonar-cognitive-img]: http://sonarcloud.io/api/badges/measure?key=gregswindle-github&metric=cognitive_complexity diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 4f36383..fc0c89a 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -64,7 +64,7 @@ Graphic art by [icons8](https://icons8.com/). [icon-justice-image]: docs/img/icons8/icon-justice-50.png [icon-pledge-image]: docs/img/icons8/icon-pledge-50.png [product-repo-logo-image]: ..docs/img/logo-commonalaxy.png -[product-repo-url]: https://github.com/gregswindle/spring-boot-starter-thymeleaf -[team-email-mailto]: mailto:greg@swindle.net?Subject=%5Bspring-boot-starter-thymeleaf%5D%20Code%20of%20conduct%20concern -[team-issues-url]: https://github.com/gregswindle/spring-boot-starter-thymeleaf/issues/new +[product-repo-url]: https://github.com/gregswindle/mvn-spring-boot-thymeleaf-nodejs +[team-email-mailto]: mailto:greg@swindle.net?Subject=%5Bmvn-spring-boot-thymeleaf-nodejs%5D%20Code%20of%20conduct%20concern +[team-issues-url]: https://github.com/gregswindle/mvn-spring-boot-thymeleaf-nodejs/issues/new [version]: http://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 643cf6f..42b7e2e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,37 +1,37 @@ -# Contributing
to `spring-boot-starter-thymeleaf` +# Contributing
to `mvn-spring-boot-thymeleaf-nodejs` > [![PRs Welcome][makeapullrequest-image]][makeapullrequest-url] > -> Welcome to `spring-boot-starter-thymeleaf`. You're among people eager to promote recommended community standards that encourage open source consumption and contributions with comprehensive `README`, `CODE_OF_CONDUCT`, `CONTRIBUTING`, and `LICENSE` documents. If you are curious, you're already a member! +> Welcome to `mvn-spring-boot-thymeleaf-nodejs`. You're among people eager to promote recommended community standards that encourage open source consumption and contributions with comprehensive `README`, `CODE_OF_CONDUCT`, `CONTRIBUTING`, and `LICENSE` documents. If you are curious, you're already a member! -__Contributions__ start with __community conversations__ that lead to __positive change.__ Open source provides a flexible collaboration model that facilitates change, even among perfect strangers. Contributions therefore: +**Contributions** start with **community conversations** that lead to **positive change.** Open source provides a flexible collaboration model that facilitates change, even among perfect strangers. Contributions therefore: - 1. Begin with __Issues__, - 2. Occur in __Pull Requests__, and - 3. End with __Merges__. + 1. Begin with **Issues**, + 2. Occur in **Pull Requests**, and + 3. End with **Merges**. ## Table of contents -- [1. __Issues__](#1-__issues__) +- [1. **Issues**](#1-issues) * [1.1. Create Issues for feature requests and defects.](#11-create-issues-for-feature-requests-and-defects) * [1.2. Format titles with **`type(scope): subject`**.](#12-format-titles-with-typescope-subject) * [1.3. Fill out the issue template.](#13-fill-out-the-issue-template) * [1.4. Label the issue (optional).](#14-label-the-issue-optional) * [1.5. Monitor your issue for questions.](#15-monitor-your-issue-for-questions) * [1.6. Your issue will be either accepted for work, or declined.](#16-your-issue-will-be-either-accepted-for-work-or-declined) -- [2. __Git__](#2-__git__) - * [2.1. __Rules__](#21-__rules__) +- [2. **Git**](#2-git) + * [2.1. **Rules**](#21-rules) + [2.1.1. Makes changes in a topic branch.](#211-makes-changes-in-a-topic-branch) + [2.1.2. Favor the topic branch naming recommendation `type/issue-change-name`.](#212-favor-the-topic-branch-naming-recommendation-typeissue-change-name) + [2.1.3. Branch out from `master`.](#213-branch-out-from-master) - + [2.1.4. __*Never*__ push into the `master` branch. __*Always*__ submit a Pull Request.](#214-__never__-push-into-the-master-branch-__always__-submit-a-pull-request) + + [2.1.4. ***Never*** push into the `master` branch. ***Always*** submit a Pull Request.](#214-never-push-into-the-master-branch-always-submit-a-pull-request) + [2.1.5. Submit a Pull Request as soon as possible.](#215-submit-a-pull-request-as-soon-as-possible) + [2.1.6. Rebase your local `master` branch before you ask for PR approvals.](#216-rebase-your-local-master-branch-before-you-ask-for-pr-approvals) + [2.1.7. Resolve rebase conflicts before Pull Request reviews.](#217-resolve-rebase-conflicts-before-pull-request-reviews) + [2.1.8. Add reviewers and the label `Status: Needs Review` when the topic branch is ready.](#218-add-reviewers-and-the-label-status-needs-review-when-the-topic-branch-is-ready) + [2.1.9. Delete local and remote topic branches after merging.](#219-delete-local-and-remote-topic-branches-after-merging) + [2.1.10. Protect your `master` branch.](#2110-protect-your-master-branch) - * [2.2. __Feature-branch-workflow__](#22-__feature-branch-workflow__) + * [2.2. **Feature-branch-workflow**](#22-feature-branch-workflow) + [2.2.1. Initialize a Git repository in the product directory (_for new repositories only_).](#221-initialize-a-git-repository-in-the-product-directory-_for-new-repositories-only_) + [2.2.2. Checkout a new `feat`ure or `fix` branch.](#222-checkout-a-new-feature-or-fix-branch) + [2.2.3. Make Changes.](#223-make-changes) @@ -43,34 +43,35 @@ + [2.2.9. Submit a Pull Request.](#229-submit-a-pull-request) + [2.2.10. Once accepted, the Pull request will be merged, closed, and deleted by an administrator.](#2210-once-accepted-the-pull-request-will-be-merged-closed-and-deleted-by-an-administrator) + [2.2.11. Remove your local topic branch if you're done.](#2211-remove-your-local-topic-branch-if-youre-done) - * [2.3. __Tell your boss how Git enables collaborative process models.__](#23-__tell-your-boss-how-git-enables-collaborative-process-models__) + * [2.3. **Tell your boss how Git enables collaborative process models.**](#23-tell-your-boss-how-git-enables-collaborative-process-models) + [2.3.1. Explain that inner and open source are _process models_.](#231-explain-that-inner-and-open-source-are-_process-models_) + [2.3.2. Describe a typical Git workflow in collaborative terms.](#232-describe-a-typical-git-workflow-in-collaborative-terms) -- [3. __Code standards__](#3-__code-standards__) - * [3.1. Use the Standard JS Style.](#31-use-the-standard-js-style) - * [3.2. Use ESLint to analyze source code.](#32-use-eslint-to-analyze-source-code) -- [4. __Unit testing__](#4-__unit-testing__) +- [3. **Code standards**](#3-code-standards) + * [3.1. Use the JavaScript Standard Style.](#31-use-the-javascript-standard-style) + * [3.2. Use ESLint to analyze JavaScript source code.](#32-use-eslint-to-analyze-javascript-source-code) + * [3.3. Run `./mvnw test` to evaluate Java code quality.](#33-run-mvnw-test-to-evaluate-java-code-quality) +- [4. **Unit testing**](#4-unit-testing) * [4.1. Write Jest tests.](#41-write-jest-tests) * [4.2. Reach 100% code coverage.](#42-reach-100%25-code-coverage) -- [5. __Directory structure__](#5-__directory-structure__) -- [6. __Logging__](#6-__logging__) -- [7. __Dependencies__](#7-__dependencies__) -- [8. __APIs__](#8-__apis__) - * [8.1 __API design__](#81-__api-design__) - * [8.2 __API security__](#82-__api-security__) - * [8.3 __API documentation__](#83-__api-documentation__) -- [9. __Licensing__](#9-__licensing__) +- [5. **Directory structure**](#5-directory-structure) +- [6. **Logging**](#6-logging) +- [7. **Dependencies**](#7-dependencies) +- [8. **APIs**](#8-apis) + * [8.1 **API design**](#81-api-design) + * [8.2 **API security**](#82-api-security) + * [8.3 **API documentation**](#83-api-documentation) +- [9. **Licensing**](#9-licensing) -## 1. __Issues__ +## 1. **Issues** ![Issues][icon-issue-image] -* __Collaboration starts with *Issues*. Changes happen through *Pull Requests*.__ +* **Collaboration starts with *Issues*. Changes happen through *Pull Requests*.** - View `spring-boot-starter-thymeleaf's` collaboration and contribution flowcharts: + View `mvn-spring-boot-thymeleaf-nodejs's` collaboration and contribution flowcharts: --- @@ -95,7 +96,7 @@ * ### 1.1. Create Issues for feature requests and defects. _Why:_ - > ⌦ `spring-boot-starter-thymeleaf` follows an issue-driven product delivery model. + > ⌦ `mvn-spring-boot-thymeleaf-nodejs` follows an issue-driven product delivery model. > Before any work is done, create an Issue, first. This starts a > conversation about features, defects ("bugs"), refactoring, product > delivery improvements, etc. @@ -162,7 +163,7 @@ CLA: Unsigned - The person who submitted a product change has __not__signed your Contributor License Agreement.

Remove this label if your product owner does not require a CLA. + The person who submitted a product change has **not**signed your Contributor License Agreement.

Remove this label if your product owner does not require a CLA. Priority: Critical @@ -303,18 +304,18 @@ > Otherwise, your issue will be politely declined. -## 2. __Git__ +## 2. **Git** ![Git Logo][icon-git-logo-image] -* ### 2.1. __Rules__ +* ### 2.1. **Rules** - `spring-boot-starter-thymeleaf` manages contributions with the [feature-branch-workflow](https://www.atlassian.com/git/tutorials/comparing-workflows#feature-branch-workflow). + `mvn-spring-boot-thymeleaf-nodejs` manages contributions with the [feature-branch-workflow](https://www.atlassian.com/git/tutorials/comparing-workflows#feature-branch-workflow). * #### 2.1.1. Makes changes in a topic branch. _Why:_ - > ⌦ Use an isolated topic branch for parallel product development. Topic branches allow you to submit multiple pull requests without confusion. You can iterate without polluting the master branch with potentially unstable, unfinished code. The `spring-boot-starter-thymeleaf` team uses: + > ⌦ Use an isolated topic branch for parallel product development. Topic branches allow you to submit multiple pull requests without confusion. You can iterate without polluting the master branch with potentially unstable, unfinished code. The `mvn-spring-boot-thymeleaf-nodejs` team uses: > > * [Feature-branch-workflow](https://www.atlassian.com/git/tutorials/comparing-workflows#feature-branch-workflow) for small-ish codebases, or > * [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows#gitflow-workflow) for large applications and monoliths @@ -362,9 +363,9 @@ * #### 2.1.3. Branch out from `master`. _Why:_ - > ⌦ `spring-boot-starter-thymeleaf` follows the feature-branch-workflow. + > ⌦ `mvn-spring-boot-thymeleaf-nodejs` follows the feature-branch-workflow. -* #### 2.1.4. __*Never*__ push into the `master` branch. __*Always*__ submit a Pull Request. +* #### 2.1.4. ***Never*** push into the `master` branch. ***Always*** submit a Pull Request. _Why:_ > ⌦ It notifies team members whenever changes occur and allows the community to review your changes at any time.. @@ -408,7 +409,7 @@ > * [GitHub protected branches](https://help.github.com/articles/about-protected-branches/) and > * [Bitbucket protected branches](https://confluence.atlassian.com/bitbucketserver/using-branch-permissions-776639807.html). -* ### 2.2. __Feature-branch-workflow__ +* ### 2.2. **Feature-branch-workflow** We use the [feature-branch-workflow](https://www.atlassian.com/git/tutorials/comparing-workflows#feature-branch-workflow). We _recommend_ [interactive rebasing](https://www.atlassian.com/git/tutorials/merging-vs-rebasing#the-golden-rule-of-rebasing), too, but that's not required. @@ -450,7 +451,7 @@ _Why:_ > Consistent, legible Git logs not only facilitate communication, but also enable automated `CHANGELOG` generation and semantic versioning with [`standard-version`][standard-version-url]. - * __`build` commit messages__ + * **`build` commit messages** Issues related to product builds. @@ -462,7 +463,7 @@