Skip to content

Latest commit

 

History

History
129 lines (90 loc) · 3.87 KB

CONTRIBUTING.md

File metadata and controls

129 lines (90 loc) · 3.87 KB

Contributing to SSP Relay

We’re excited that you’re considering contributing to SSP Relay! As the communication backbone of the SSP Wallet ecosystem, SSP Relay ensures secure, reliable interactions between SSP Wallet and SSP Key. Your contributions are essential in maintaining and improving this critical infrastructure.

For technical details and guidelines, please refer to the SSP Documentation.

Code of Conduct

Please review and follow our Code of Conduct. By participating, you agree to foster a respectful and inclusive environment.

Ways to Contribute

1. Report Bugs

If you identify an issue:

  • Create an issue and include:
    • Steps to reproduce the problem.
    • Logs, error messages, or screenshots if applicable.
    • Environment details (Node.js version, MongoDB version, OS).

2. Suggest Features

Have ideas to enhance SSP Relay? Open a feature request in the issues section. Provide as much detail as possible, including use cases and the problem the feature addresses.

3. Improve Documentation

Help us enhance the documentation by contributing updates or creating new guides. For reference, see the SSP Documentation.

4. Submit Code Contributions

Assist by fixing bugs, adding features, or improving performance. Contributions to enhance scalability, security, or usability are especially valuable.

Development Environment

Prerequisites

  • Node.js: Version 20 or higher
  • MongoDB: A running MongoDB instance

Setting Up

  1. Fork the Repository

    git clone https://github.com/runonflux/ssp-relay 
cd ssp-relay

  2. Install Dependencies

    yarn install

  3. Start the Development Server

    yarn dev

Refer to the SSP Documentation for detailed setup and usage guidelines.

Coding Guidelines

Style Guide

  • Follow our ESLint configuration for consistent code style.
  • Format code using Prettier

Type Checking

Ensure TypeScript types are correct by running:

yarn type-check

Testing

  • Write tests for new features or bug fixes.
  • Run tests locally to ensure reliability: 
    yarn test

Submitting a Pull Request

Follow these steps to submit a PR:

  1. Create a New Branch

    git checkout -b feature/your-feature-name

  2. Make Changes

    • Focus on a specific issue or feature.
    • Ensure all tests and linter checks pass before committing.

  3. Commit Your Changes
    Use clear and descriptive commit messages:

    git commit -m "Add feature: your-feature-description"

  4. Push Your Branch

    git push origin feature/your-feature-name

  5. Open a Pull Request

    • Submit your PR to the main branch of the SSP Relay repository.
    • Provide a summary of your changes and link to any relevant issues.

Resources

Need Help?

If you have questions or need assistance:

We’re excited to collaborate with you. Together, let’s make SSP Relay a secure and efficient bridge for the SSP ecosystem!