OpenZeppelin / OpenZeppelin/compact-contracts

Add Compact Conventions to GUIDELINES.md

Open
#114 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation stale
Dominant language
TypeScript
Stars
55
Forks
29
Avg merge
5d 7h
Merged PRs (30d)
25

Description

At the moment it's a bit pre-mature to enforce any Compact conventions in our repo GUIDELINES.md since the language is still rapidly evolving. We should revisit this in the future when it has stabilized and consensus on best practices has emerged.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review GUIDELINES.md and the issue statement before starting. This work is explicitly deferred until Compact stabilizes and consensus on best practices emerges; it is done only when those conventions are agreed and documented.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.