Skip to main content

Contribution Guidelines

Overview​

Welcome to the Circle Layer community! This guide will help you contribute to our project.

How to Contribute​

1. Code Contributions​

  • Fork the repository
  • Create a feature branch
  • Make your changes
  • Submit a pull request

2. Documentation​

  • Improve existing docs
  • Add new tutorials
  • Fix typos and errors
  • Update outdated information

3. Bug Reports​

  • Use the issue tracker
  • Provide detailed steps to reproduce
  • Include error messages
  • Specify your environment

Development Workflow​

  1. Setup 
    git clone https://github.com/circlelayer/testnet-core-blockchain.git
    cd circle-layer
    npm install

  2. Testing 
    npm run test
    npm run lint

  3. Building 
    npm run build

Code Standards​

  • Follow the style guide
  • Write unit tests
  • Document your code
  • Keep commits atomic

Review Process​

  1. Submit PR
  2. Automated checks
  3. Code review
  4. Merge or request changes

Getting Help​

  • Join our Telegram community
  • Check the FAQ
  • Read the documentation
  • Follow us on X for updates