Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 3.81 KB

CONTRIBUTING.md

File metadata and controls

79 lines (56 loc) · 3.81 KB

How to contribute to Jetton

❤️ It's great that you are interested! Thank you for investing your time in this project!

📖 This document is guideline for contributing to this repo. If you are looking for "How to work with jetton" please follow this document

ℹ️ The following text is mostly guideline and not rule. Use your best judgment, and feel free to propose changes to this document in a pull request.

How can i contrubute

Reporting bugs

We are tracking bugs in GitHub issues. If you found an bug, open new issue with "bug" label.

If you think you found vulnerabilty or security related issue, do not open issue, create vulnerability report.

Enhancements proposal

We are tracking feature suggestions in GitHub issues. if you want to propose new feature, feel free to open issue with "enhancement" label.

Code contribution

To work with application locally you will need Node.js version 22+.

Here is a list of used dependencies in project:

  • Tact Lang - programming language for TON Blockchain, we using it for writting smart contract code
  • Typescript - programming language we using for testing and scripting smart contracts
  • Jest - testing framework
  • Prettier - for code formatting
  • Blueprint - development environment for TON blockchain for writing, testing, and deploying smart contracts
  • TON Sandbox - local TON emulator we are using for testing smart contract

How to build smart contract

npx blueprint build

How to run tests

npx blueprint test

Project structure

  • contracts - source code of all the smart contracts
    • jetton - entrypoints of jetton contracts with dependencies (traits) specified
      • master.tact - jetton master contract entrypoint
      • wallet.tact - jetton wallet contract entrypoint
    • teps - traits with TEPs realization
      • messages - API messages for TEP traits
        • discoverable - messages related to the tep89 "discoverable" trait
        • jettonStandard - messages related to the tep74 jettons standard
      • tep64.tact - trait implementation of TEP 64
      • tep74.tact - trait implementation of TEP 74
      • tep89.tact - trait implementation of TEP 89
    • consts.tact - project constants
    • errors.tact - custom project error codes (exit codes)
    • messages.tact - contracts API messages

Styleguide

Git Commit Message

  • Use Conventional Commits commit format
  • Use the present tense ("feat: add feature" not "feat: added feature")
  • Use the imperative mood ("fix: move file to..." not "fix: moves files...")
  • Use lowercase first letter ("docs: update README.md" not "docs: Update README.md")
  • Limit the first line to 72 characters or less