Skip to content

FOR_DEVELOPERS.md

Latest commit

 

History

History
86 lines (54 loc) · 2.13 KB

FOR_DEVELOPERS.md

File metadata and controls

86 lines (54 loc) · 2.13 KB
Raw

For Developers

Latest Release Information

This document is updated for REChain version 4.1.10+1160, released on 2025-12-06.

Introduction

Welcome to the REChain developer guide. This document provides essential information, tools, and best practices to help developers contribute effectively to the REChain ecosystem.

Getting Started

  • Clone the repository: git clone https://github.com/sorydima/REChain-.git
  • Install dependencies: flutter pub get
  • Set up your development environment according to the DEVELOPER_ONBOARDING.md guide.
  • Run the app locally: flutter run

Development Workflow

  • Follow the CONTRIBUTING.md guidelines for submitting code and documentation.
  • Use feature branches for new work.
  • Write clear, concise commit messages.
  • Ensure all tests pass before submitting pull requests.
  • Participate in code reviews and discussions.

Code Structure

  • lib/: Main application code.
  • test/: Unit and integration tests.
  • scripts/: Utility scripts for building, testing, and deployment.
  • docs/: Documentation and guides.
  • bridges/: Bridge configurations and integrations.

Testing

  • Write unit tests for new features and bug fixes.
  • Run tests with flutter test.
  • Use integration tests for end-to-end scenarios.
  • Ensure code coverage is maintained or improved.

Tools and Resources

  • Shorebird for code push updates.
  • GitHub Actions for CI/CD.
  • Matrix channels for community support.
  • Documentation and API references in the wiki.

Security

  • Follow best practices outlined in SECURITY.md.
  • Report vulnerabilities responsibly.
  • Use encryption and secure coding standards.

Contribution Recognition

  • Contributors are acknowledged in the MAINTAINERS.md file.
  • Significant contributions may be highlighted in release notes.

Additional Support

This guide is part of the REChain v4.1.10+1160 release documentation.