Developer Documentation to onboard interested contributors.

[diivi]

Type of feature

📝 Documentation

Current behavior

Currently, jumping in and contributing to the codebase seems a bit difficult, considering all the design decisions we have taken are not documented, and even I need to refer to past components to add new ones.

This adds friction and makes onboarding new devs difficult.

Suggested solution

I suggest adding a CONTRIBUTING.md with all the design decisions that we've taken; it should convey the following (at least):

1. How to manipulate the GitHub website to add custom components. (the whole dom-utils -> components etc flow)
2. How to edit/add features to the extension popup.

Adding new features is good, but we should probably leave issues like #59 and #66 open for new contributors and add some docs for our decisions.

This is more of a documentation tracker than a single issue:

• Add DOM manipulation docs
• Add extension popup editing docs
• How do we do authentication?
• How is state managed

etc.

Additional context

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

Contributing Docs

• I agree to follow this project's Contribution Docs

[bdougie]

This is a good idea. The open sauced org has a base contributing.md in the open-sauced/.github repo.

I'd actually prefer adding a design or docs folder in the repo instead that outlines the decisions made and how to interact.

[diivi]

I'll create a docs folder inside the repo itself, that sounds like a better idea.

I'll need help from other contributors to best explain the features that they added though.

[bdougie]

I'll need help from other contributors to best explain the features that they added though.

Most folks are accessible via the discord

[a0m0rajab]

Just a minor suggestion here, I think adding some information on how to add a simple feature or a blog on how we wrote a feature for this can be helpful. Instead of reading the whole code, we can guide the contributor through an example plus show them how to use search tools in GitHub and how to understand the needed part of the codebase.

The full explanation of the codebase is awesome to have for a deeper understanding.

[diivi]

Will use the Docs Tracker for docs issues.