Skip to content

Contributing.md

Latest commit

 

History

History
89 lines (55 loc) · 2.32 KB

Contributing.md

File metadata and controls

89 lines (55 loc) · 2.32 KB

Contributing to REChain

Latest Release Information

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

Introduction

Thank you for your interest in contributing to REChain! This guide provides information on how to contribute code, documentation, and other improvements to the project.

How to Contribute

Reporting Issues

  • Use the GitHub issue tracker to report bugs, suggest features, or ask questions.
  • Provide clear, detailed descriptions and steps to reproduce issues.
  • Include relevant logs, screenshots, or error messages.

Submitting Pull Requests

  • Fork the repository and create a feature branch.
  • Follow the coding style and guidelines outlined in CODE_STYLE.md.
  • Write clear, concise commit messages.
  • Include tests for new features or bug fixes.
  • Ensure all tests pass before submitting.
  • Submit pull requests against the main branch.
  • Use the PULL_REQUEST_TEMPLATE.md for consistency.

Documentation Contributions

  • Improve or add documentation in the docs/ directory.
  • Follow the documentation style and formatting guidelines.
  • Submit pull requests with clear descriptions of changes.

Code of Conduct

  • Please adhere to the CODE_OF_CONDUCT.md to maintain a welcoming and respectful community.

Development Workflow

  • Use feature branches for new work.
  • Keep branches up to date with the main branch.
  • Participate in code reviews and discussions.
  • Address review comments promptly.

Testing

  • Write unit and integration tests for your changes.
  • Run all tests locally before submitting.
  • Use continuous integration tools to verify builds and tests.

Communication

  • Join the REChain community on Matrix for real-time discussions.
  • Use GitHub discussions and issues for asynchronous communication.
  • Contact support@rechain.network for assistance.

Recognition

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

Additional Resources

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