https://github.com/contentmunch/blog-api

https://github.com/contentmunch/blog-api

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/contentmunch/blog-api
• Owner: contentmunch
• License: mit
• Created: 2022-06-12T18:40:49.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-16T17:29:39.000Z (10 months ago)
• Last Synced: 2024-03-16T22:54:56.945Z (10 months ago)
• Language: Java
• Size: 74.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# blog-api

API for retrieving blog.

## Using blog-api

To use this library:

* add the mvn package to your pom.xml

* requires spring boot version 2.7.0+

## Coding rules

We use [GitHub Flow](https://guides.github.com/introduction/flow/) for our project workflow. To ensure consistency

throughout the source code, keep these rules in mind as you are working:

* Create pull request against develop to merge your code.

* All features or bug fixes **must be tested** by one or more [specs][unit-testing].

### Pull request format

```

* changes 1

* changes 2

fixes/closes #

```

### Git commit format

  ```

  : 

   

   optional

  ```

* Any line of the commit message cannot be longer 100 characters. This allows the message to be easier to read on GitHub

  as well as in various git tools.

* The subject contains succinct description of the change:

    * use the imperative, present tense: "change" not "changed" nor "changes"

    * no dot (.) at the end

* Commit type:

    * feat: a new feature

    * fix: a bug fix

    * refactor: a code change that neither fixes a bug nor adds a feature

    * test: adding missing tests

    * chore: changes to the build process or auxiliary tools and libraries such as documentation generation