microsoft / microsoft/gctoolkit
Architecture Document and Diagram(s)
Open
@dsgrieve is already working on this.
Since Oct 7, 2021.
documentation
enhancement
good first issue
- Dominant language
- Java
- Stars
- 1.3k
- Forks
- 177
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 3
Description
In order to help contributors understand how and where they can add, extend, refactor, etc. I think a minimum is:
- A description of each package/layer and its responsibilities.
- Any major 'Why' explanations for design patterns or implementations that may not be obvious to a new contributor.
- A picture speaks a thousand words.
Perhaps other things.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.