OpenZeppelin / OpenZeppelin/compact-contracts
Define Compact comment conventions
Open
Nobody has claimed this yet.
documentation
stale
- Dominant language
- TypeScript
- Stars
- 55
- Forks
- 29
- Avg merge
- 5d 7h
- Merged PRs (30d)
- 25
Description
It should take docgen into account
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.
Research direction
The issue only identifies docgen as a consideration and does not name a file, entry point, or existing convention. Start by locating the project’s comment-convention guidance and docgen configuration, then determine the intended Compact rules and how docgen should account for them. Done means the conventions and their docgen impact are clearly defined and documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100