Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (58 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

76 lines (58 loc) · 1.83 KB

Contributing to EstateChain

Thank you for your interest in contributing to EstateChain! This document provides guidelines and steps for contributing to our project.

Code of Conduct

Please read and follow our Code of Conduct.

How to Contribute

  1. Fork the Repository

    • Click the 'Fork' button on the repository page
    • Clone your forked repository to your local machine

  2. Set Up Development Environment

    git clone https://github.com/your-username/estate-chain.git
cd estate-chain
npm install

  3. Create a New Branch

    git checkout -b feature/your-feature-name

  4. Make Your Changes

    • Follow our coding standards
    • Write tests for new features
    • Update documentation as needed

  5. Commit Your Changes

    git commit -m "Description of your changes"

  6. Push to Your Fork

    git push origin feature/your-feature-name

  7. Create a Pull Request

    • Go to the original repository
    • Click 'New Pull Request'
    • Select your branch
    • Fill in the PR template
    • Submit the PR

Development Guidelines

Code Style

  • Use TypeScript for all new code
  • Follow ESLint and Prettier configurations
  • Write meaningful commit messages
  • Keep functions small and focused

Testing

  • Write unit tests for new features
  • Ensure all tests pass before submitting PR
  • Maintain or improve test coverage

Documentation

  • Update README.md for significant changes
  • Document new features and APIs
  • Keep comments clear and concise

Pull Request Process

  1. Ensure your PR addresses a single issue
  2. Include tests and documentation
  3. Request review from maintainers
  4. Address review comments
  5. Wait for approval before merging

Questions?

Feel free to open an issue if you have any questions about contributing!