Skip to content

Amsterdam/ee-docs-importer

Engineering Enablement React Template

Team responsible: Engineering Enablement team

Aims of this repo

To produce a Node.js command that copies and save valid markdown documents from the development-standards repository.

Features

This repo uses the ee-react-template project template. Any frontend features have been removed.

Usage

The starter contains the following scripts:

  • import [dir] - starts the import; [dir] is optional, replace it with your directory of choice, otherwise it defaults to docs
  • build - generates the production bundle
  • test - starts vitest and runs all tests
  • test:coverage - starts vitest and run all tests with code coverage report
  • lint:scripts - lint .ts, .tsx and .json files with eslint
  • format:scripts - format .ts, .html and .json files with prettier
  • format - format all with prettier
  • prepare - script for setting up husky pre-commit hook
  • uninstall-husky - script for removing husky from repository

How to contribute to this repo?

Simply create and submit a pull request. You can also contact us via Teams (DV - Engineering Enablement) or Slack (#engineering-enablement).

Generating a release

This project uses Release it! to automate versioning and utilizes Commitizen to generate consistent and meaningful changelogs.

There is a demo repository available with an explanation and some example flows.

In short

In short:

  • Features and bug fixes should be merged into develop with a Commitizen friendly commit message.
  • When generating a new release, a new branch release/[branch-name] should be created from develop. In GitHub this will trigger the Release action, which will run Release it! Then the branch can be merged to main.
  • Don't forget to merge main back into develop when complete.

The release/[branch-name] step is crucial, as you may have other important actions listening to the main branch, like deploying or publishing your latest application. If the Release action were to run on main, it would effectively mean your actions are triggered twice, as it generates another commit.

Acknowledgments

Original template repo

About

No description, website, or topics provided.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •