Skip to content

Latest commit

 

History

History
140 lines (101 loc) · 4.05 KB

CONTRIBUTING.md

File metadata and controls

140 lines (101 loc) · 4.05 KB

Contributing to SSP Key

We’re thrilled that you’re considering contributing to SSP Key! Your efforts are vital in improving this powerful two-factor authentication tool and its seamless integration with SSP Wallet. Whether you’re reporting bugs, suggesting features, or enhancing the codebase, your contributions are deeply valued.

For detailed technical information, please refer to the SSP Documentation.

Code of Conduct

Please read and follow our Code of Conduct. By participating in this project, you agree to foster a respectful and inclusive environment.

Ways to Contribute

1. Report Bugs

If you find a bug:

  • Create an issue and include:
    • Steps to reproduce the issue.
    • Screenshots, logs, or error messages if applicable.
    • Information about your setup (OS, device, app version).

2. Suggest Features

Got an idea to improve SSP Key? Submit a feature request in the issues section. Be as detailed as possible and explain the problem it solves.

3. Improve Documentation

Help make SSP Key accessible to everyone by contributing to guides, FAQs, or translations. Visit Crowdin to contribute to translations. For technical documentation, check the SSP Documentation.

4. Submit Code Contributions

Assist in building new features, fixing bugs, or refining the codebase by submitting a pull request (PR).

Development Environment

Prerequisites

  • Node.js: Version 20 or higher
  • Yarn: Latest version
  • React Native CLI: Ensure the CLI is properly installed.

Setting Up

  1. Fork the repository.
  2. Clone your fork: 
    git clone https://github.com/runonflux/ssp-key
  3. Install dependencies: 
    yarn install
  4. Start the development server: 
    yarn start

Refer to the SSP Documentation for further setup details.

Coding Guidelines

Style Guide

  • Follow our ESLint configuration and use Prettier for code formatting.
  • Run the linter before committing: 
    yarn lint

Prettier Configuration

Ensure your editor supports Prettier.

Type Checking

The project uses TypeScript. Run type checks locally with:

yarn type-check

Testing

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

Submitting a Pull Request

Follow these steps to submit a PR:

  1. Create a New Branch
    Use a descriptive branch name:

    git checkout -b feature/your-feature-name

  2. Make Changes

    • Keep changes focused on a specific issue or feature.
    • Ensure tests and linter checks pass before committing.

  3. Commit Changes
    Write clear, descriptive commit messages:

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

  4. Push to Your Fork

    git push origin feature/your-feature-name

  5. Open a Pull Request

    • Go to your fork and create a pull request against the main branch of the SSP Key repository.
    • Provide a summary of your changes and link to any relevant issues.

PR Tips

  • Follow our coding standards and include tests.
  • Keep your PR concise and focused.
  • Open a draft PR for early feedback on significant changes.

Resources

Need Help?

If you have questions or encounter issues:

We’re excited to have you on board. Together, let’s make SSP Key a secure, simple, and powerful tool for the crypto community!