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

[Milestone] External Contributor Friendly #4

Open
mfw78 opened this issue Sep 17, 2023 · 0 comments
Open

[Milestone] External Contributor Friendly #4

mfw78 opened this issue Sep 17, 2023 · 0 comments
Assignees
Labels
milestone Tracks a subteam milestone

Comments

@mfw78
Copy link
Contributor

mfw78 commented Sep 17, 2023

Milestone: https://github.com/cowprotocol/pm/milestone/1
Priority Tracks: Production Readiness, Growth

Summary

Enable external developers to easily build with CoW Protocol, and contribute to cowprotocol repositories.

This milestone will deliver the following:

1. Documentation

In addition to generally updating the documentation so that information retained is relevant, the documentation is to be updated to follow an "actor" based methodology, allowing developers / users to easily lookup documentation based on their desired act within CoW Protocol.

In order to assess the usability of the new documentation format, feedback mechanisms will be required.

2. Contained, forkable repositories

Provide contained, narrow, opinionated repositories that developers can easily clone (essentially providing a "github recipes"). These are to be tightly coupled, and thus complimentary to documentation.

Justification

Due to rapid iteration, examples and documentation often dates rapidly for CoW Protocol. This barrier for entry needs to be lowered significantly in order to encourage external contributors / developers.

RAID (Risks, Assumptions, Issues and Dependencies)

Dependencies: @cowprotocol/frontend for docusaurus theming.

@mfw78 mfw78 added the milestone Tracks a subteam milestone label Sep 17, 2023
@mfw78 mfw78 self-assigned this Sep 17, 2023
@mfw78 mfw78 added this to the External Contributor Friendly milestone Sep 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
milestone Tracks a subteam milestone
Projects
None yet
Development

No branches or pull requests

1 participant