ucb-bar/chipyard

Integrating Subproject Requirement Documentation

Open

#355 opened on Dec 6, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (2,255 stars) (857 forks)batch import
help wanted

Description

As discussed in the main Chipyard meeting, we need to consider some documentation about what rules and requirements there are to participate in Chipyard. And if the rules are not followed, how to get rid of them from Chipyard.

  • What is the threshold for integrating a subproject into Chipyard?
    • Documentation on how to add to a config? what it is?
    • Works with current CI? Must add their own CI?
  • What is the level of engagement in development that we expect from the subproject developers?
    • If main Chipyard devs push something and it breaks the subproject... how fast should the subproject respond?
    • If there is no response, is there a checklist of things that main developers can use to determine if the project can be removed?

Contributor guide

Tech stack
scala
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
Familiarity with ChipyardUnderstanding of subproject integration flow
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Review existing documentation in the Chipyard repository for any guidelines on subproject integration. Investigate community meeting notes for context on the discussion. Propose a set of rules and requirements for subproject integration, including criteria for removal. Document the process in a new section of the project's documentation.