Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1007 Bytes

CONTRIBUTING.md

File metadata and controls

38 lines (29 loc) · 1007 Bytes

Contributing

Development

Install global dependencies:

  • Node.js LTS
  • Go >= 1.21

Install project dependencies:

pushd report && npm install && popd

Build and run:

  • Build the report template (report/): npm run build
    or for report template development:
    • Create a data.js file with some stub data (e.g. from a real report):
      var files = [/* stub data */];
      var pathSeparator = "/";
    • Run: npm run dev
  • Build and run DirStat: go run "cmd/dirstat.go" [...]

Release

  • Update the version number in:
  • Update the changelog
  • Commit changes: git commit -a -m "Release X.Y.Z"
  • Merge develop in main: git switch main && git merge develop --ff-only
  • Create the tag: git tag "X.Y.Z" -a -m "X.Y.Z"
  • Push to the repository: git push --all origin && git push --tags