Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 2.2 KB

Contributing to KrypCore-Web3-SDK

Thank you for considering contributing to KrypCore-Web3-SDK! We welcome contributions from the community to help improve and enhance our SDK.

How to Contribute

To contribute to KrypCore-Web3-SDK, please follow these steps:

  1. Fork the repository and clone it to your local machine.
  2. Create a new branch for your contribution:
    • For bug fixes: git checkout -b fix/your-fix-name
    • For new features: git checkout -b feature/your-feature-name
  3. Make your changes and test thoroughly.
  4. Commit your changes with a descriptive commit message using the guidelines below.
  5. Push your changes to your forked repository.
  6. Submit a pull request to the main branch of the KrypCore-Web3-SDK repository.
  7. Your pull request will be reviewed by the maintainers, and any necessary feedback or changes will be requested.
  8. Once your pull request is approved, it will be merged into the main branch.

Guidelines for Contribution

When contributing to KrypCore-Web3-SDK, please adhere to the following guidelines:

  • Follow the coding style and conventions used in the existing codebase.
  • Write clear and concise commit messages.
  • Ensure your code is well-tested and doesn't introduce any regressions.
  • Provide appropriate documentation and comments for new features or significant changes.
  • Respect the existing code structure and avoid unnecessary refactoring unless it improves the overall quality of the codebase.
  • Be responsive to any feedback or questions during the review process.

Code of Conduct

Please note that by contributing to KrypCore-Web3-SDK, you are expected to follow the Code of Conduct of the project.

Reporting Issues

If you encounter any bugs or issues while using KrypCore-Web3-SDK, please report them by opening a new issue in the Issue Tracker. Provide as much detail as possible, including steps to reproduce the issue, error messages, and your environment details.

Getting Help

If you need any assistance or have questions related to KrypCore-Web3-SDK, please reach out to us through Discord.

We appreciate your valuable contributions to KrypCore-Web3-SDK and look forward to building a better SDK together!