Contribution Guidelines

TMAWallet is an evolving project, and we welcome contributions from the developer community. This section outlines how you can contribute to TMAWallet, including reporting issues, submitting pull requests, and adhering to the project's coding standards.

1. Reporting Issues

• GitHub Issues: If you encounter a bug, have a question, or want to request a new feature, please use the GitHub Issues section. Provide as much detail as possible, including:

  • Steps to reproduce the issue

  • Expected behavior

  • Actual behavior

  • Version of the SDK being used

• Templates: Use the provided templates for bug reports and feature requests to ensure your issue is addressed efficiently.

2. Submitting Pull Requests

• Fork the Repository: Start by forking the TMAWallet GitHub repository and cloning it locally.

• Create a Branch: Create a new branch for your feature or bug fix. Use descriptive branch names such as feature/add-new-endpoint or fix/wallet-creation-bug.

• Write Clear Commit Messages: Commit messages should be concise and descriptive. Explain the reason for the changes in a way that other developers can understand.

• Adhere to Coding Standards: Follow the project's coding standards, which include proper formatting, clear comments, and adherence to best practices. All changes should be linted and formatted before submission.

• Testing: Ensure that your code is fully tested. If you are adding new functionality, include unit tests to verify your changes.

• Open a Pull Request: Once your changes are ready, open a pull request (PR) on the main repository. Provide a detailed description of the changes and why they are necessary. Reference any related issues in the PR description.

3. Code of Conduct

• Respectful Collaboration: Be respectful when interacting with other contributors. Constructive feedback is encouraged, but it should always be delivered with empathy and professionalism.

• Inclusivity: We welcome contributors from all backgrounds. Our goal is to create a positive and inclusive environment where everyone feels comfortable contributing.

4. Development Setup

• Prerequisites: Ensure you have Node.js and npm installed. You may also need other tools depending on the feature you're contributing to.

• Local Setup:

  • Clone the repository: git clone https://github.com/tmawallet/tmawallet-sdk.git

  • Install dependencies: npm install

  • Run tests to verify the setup: npm test

• Development Guidelines:

  • Follow the project's folder structure and naming conventions.

  • Use environment variables for sensitive information. Never hard-code API keys or secrets.

5. Documentation Contributions

• Improving Documentation: We encourage contributions to the SDK documentation. This includes adding new sections, correcting errors, and improving clarity.

• Examples and Tutorials: Adding examples, tutorials, and guides can greatly help other developers. If you have integrated TMAWallet into your project and would like to share your experience, feel free to contribute a tutorial.

6. Reviewing and Merging

• Review Process: Pull requests are reviewed by the core team. The review process includes checking for code quality, adherence to standards, and adequate test coverage.

• Approval and Merge: Once approved, your pull request will be merged into the main branch. Contributors may be asked to make changes based on reviewer feedback before merging.

7. Getting Help

• Community Support: Join our community chat on Telegram or Discord to ask questions, discuss features, and get help from other contributors and the core team.

• Official Documentation: Refer to the official documentation for setup, usage, and troubleshooting instructions. The documentation is continuously updated to reflect the latest changes in the SDK.

By contributing to TMAWallet, you are helping to build an open and secure wallet solution for Telegram mini-apps. We appreciate your involvement and look forward to your contributions!