Contributor docs #551
Closed
Contributor docs #551
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
theref
force-pushed
the
contribute-docs
branch
2 times, most recently
from
a11fd5b
to
bf8e06d
Compare
manumonti
requested changes
Jul 24, 2024
| This is the api that we expose to developers. | ||
| It is defined in [`packages/taco/src/taco.ts`](https://github.com/nucypher/taco-web/blob/main/packages/taco/src/taco.ts) | ||
|
|
||
| # Design and Architecture |
There was a problem hiding this comment.
Is CONTRIBUTING.md the right place to discuss the design and architecture? Should we move this to Threshold Docs or taco package docs?
There was a problem hiding this comment.
It's possibly the wrong heading - maybe Structure? it's supposed to be a section that helps new contributors get to grips with how the whole repo is laid out and organised
There was a problem hiding this comment.
If it has to do with repo structure, we should describe how the pnpm workspace works, not API design
|
We may also want to add a note about https://www.conventionalcommits.org/en/v1.0.0/ |
Co-authored-by: Manuel Montenegro <[email protected]>
| ### [`nucypher/taco-web`](../../README.md) | ||
| ### [`nucypher/taco-web`](https://github.com/nucypher/taco-web/blob/main/README.md) |
There was a problem hiding this comment.
Why this change? Didn't the relative link work?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of PR:
Required reviews:
What this does:
Issues fixed/closed: