Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Formalize InstructLab Change and Enhancement proposals (ICE) #118

Open
tiran opened this issue Jul 18, 2024 · 1 comment
Open

Formalize InstructLab Change and Enhancement proposals (ICE) #118

tiran opened this issue Jul 18, 2024 · 1 comment

Comments

@tiran
Copy link

tiran commented Jul 18, 2024

InstructLab has reached a critical point where we should start to formalize larger changes. For one, the code base and feature scope has become too complex for one person to grasp the impact of a change. Downstream has started to productize InstructLab. Any breaking changing can have a negative impact.

I propose to adopt a formal change proposal similar to change proposals in project like

A standardized change proposal document and process not only helps the author to formulate their idea. It also helps reviewers, QE, docs writer, downstream, and community to understand and assess a proposal. QE will know which E2E tests they have to update or create. Docs team can update docs accordingly. Community has an abstract for each major change in a release.

In additional to implementation details, an * InstructLab Change and Enhancement proposal* (ICE) should contain:

  • abstract
  • rational and motivation
  • goals / non-goals
  • risks / benefits
  • how to test
  • how to document and teach
@nathan-weinberg
Copy link
Member

+1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants