neoblog on nOS

This creates a project boilerplate for React with a custom stack

Purpose

The goal is to provide an implementation of NeoBlog on nOs.

Setup

$ git clone https://github.com/nOs/example-neoblog.git
$ cd example-neoblog
$ yarn
$ yarn start

Testing

Use yarn test:local or npm run test:local to run all tests locally. The test command is reserved for CI builds.

Project guidelines

Branches

• master and development are protected and require a PR with approved reviews for changes
• Use Conventional Commits' types for branches and camelCase the topic: feat/ui, fix/login, chore/refactorHomePage
• use Squash Merge - when possible - and reference the pull request in the conventional commit message: feat(ui): added responsive styling (#1)

Committing and versioning

This project adheres to Semantic Versioning and Conventional Commits. Don't forget to scope your commits!

We use the following types everywhere: feat, fix, chore and docs. Refactor and test commits are considered chores. We only use BREAKING CHANGE when pushing, surprise surprise, breaking changes from development to master.

Merging a BREAKING CHANGE commit to master corresponds with a Major version, feat with minor and fix with patch. Bundle your chore and docs commits with any of the previously mentioned types.

Don't forget to update the version in package.json as well before you merge a version update in development! Because after every push to master, a corresponding tag should be created detailing all changes added to this new version in the summary and CHANGELOG.md.

Husky has been added to provide automated precommit functionality that's hooked into Prettier and Jest. You still need to git add these changes and amend them to the previous commit, so don't forget to amend the changes before you push!

Changelogs

Speaking of changelogs! When pushing changes to development that warrant a version update, group changes per version and then per type. Order your change types like this (but only use what's applicable):

• Documentation
• Chores
• Bug Fixes
• Features
• BREAKING CHANGES

You can find inspiration in this entry here.

Known issues

Build assets to dedicated subdirectory parcel-bundler/parcel#233