Skip to content

As a nabledge developer, I want the README to cover the full development workflow so that I can start any task without searching outside the repo #414

Description

@kiyotis

Situation

The README has sections for setup, branch strategy, custom commands, and release steps. However, the development workflow is incomplete: skill improvement, bug fixing, Nablarch source updates, and benchmark runs are not covered.

Pain

Developers starting an improvement, bug fix, source update, or benchmark run have no entry point in the README and must search through scattered rule files and tools directories.

Benefit

  • Developers can open the README and immediately understand the full workflow: setup → develop → release
  • Onboarding time decreases because the starting point for every task is clear

Success Criteria

  • Setup: a developer can set up the development environment
  • Development:
    • improve a skill or fix a bug
    • incorporate Nablarch source updates
    • run a benchmark
  • Release:
    • verify the setup before release
    • bump the version and publish on nablarch/nabledge

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions