Skip to content

Add CONTRIBUTING.md and ARCHITECTURE.md#174

Merged
yoavbls merged 4 commits intomainfrom
feat/add-contributing-guide
Mar 28, 2026
Merged

Add CONTRIBUTING.md and ARCHITECTURE.md#174
yoavbls merged 4 commits intomainfrom
feat/add-contributing-guide

Conversation

@kevinramharak
Copy link
Copy Markdown
Collaborator

@kevinramharak kevinramharak commented Jan 28, 2026

Fixes #159 (and #78).

Adds the following documentation:

  • CONTRIBUTING.md
  • ARCHITECTURE.md

This should lower the barrier of contributing to this repository and hopefully allow people to contribute to not only the source code, but also the open issues and discussion.

DRAFT:
So far I drafted the contributing guide from https://contributing.md/, and some online examples. I also wrote down the things in my head that are probably useful when developing the project. Feel free to add suggestions and changes.

Remaining things to add:

  • write up ARCHITECTURE.md
  • add instructions to build and locally install .vsix files
  • add instructions how to create a new VS Code profile, to make it easier to choose what extensions are installed when debugging

Copy link
Copy Markdown

@MichaelDimmitt MichaelDimmitt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My comment seems like a lot but it really is just asking what npm run dev does for the various apps in the mono repo.

@yoavbls
Copy link
Copy Markdown
Owner

yoavbls commented Feb 8, 2026

Hey, is it ready for review and merge?

@kevinramharak
Copy link
Copy Markdown
Collaborator Author

Hey, is it ready for review and merge

Not yet, just a few more things to write up and add Michael's suggestions

@kevinramharak kevinramharak marked this pull request as ready for review March 26, 2026 22:40
@kevinramharak kevinramharak requested review from MichaelDimmitt and yoavbls and removed request for MichaelDimmitt March 26, 2026 22:40
Copy link
Copy Markdown
Collaborator Author

@kevinramharak kevinramharak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yoavbls @MichaelDimmitt I'm just finishing this up for now. ARCHITECTURE.md could be filled in more and I still want to add something to explain the profiles, because its a usefull debugging tip, but for now this has been open long enough. I will create seperate issues for those to fill it in more. This should be enough of an improvement to give people some guidance when checking out the project.

@MichaelDimmitt
Copy link
Copy Markdown

Looks good thanks for adding this!

@yoavbls yoavbls merged commit 2bb9325 into main Mar 28, 2026
2 checks passed
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

Successfully merging this pull request may close these issues.

Add Local Dev Setup instructions to Contributors.md (mono repo)

3 participants