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.

Sign up for GitHub

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

Jump to bottom

Improve open source documentation for smart contracts and its tests #191

Open
4 tasks
thedarkjester opened this issue Oct 16, 2024 · 0 comments
Open
4 tasks

Improve open source documentation for smart contracts and its tests #191

thedarkjester opened this issue Oct 16, 2024 · 0 comments
Labels
Contracts Smart Contract related documentation Improvements or additions to documentation

Comments

@thedarkjester
Copy link
Collaborator

Description

Improve open source documentation for smart contracts that covers Styling, Linting, Folder structure, and naming conventions for both the smart contracts and its tests.

Motivation

This will make it easier for external contributors to submit pull requests and for the team to validate the PRs in a consistent manner.

Tasks

  • Add documentation for Smart Contracts
  • Add documentation for Smart Contract Testing

Acceptance criteria

  • Documentation is clear and easy to understand

Risks

  • These are risks that may prevent completion of the task as well as areas to pay special attention to
@thedarkjester thedarkjester added Contracts Smart Contract related documentation Improvements or additions to documentation labels Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Contracts Smart Contract related documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@thedarkjester