Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

84 lines (57 loc) · 2.55 KB

Contributing to Create Kalp Dapp

Thank you for your interest in contributing to Create Kalp Dapp! Your help is valuable in improving and expanding this project. Below are guidelines to help you get started.

How Can You Contribute?

1. Reporting Issues

If you encounter any bugs or have suggestions for new features, please open an issue in our GitHub repository.

2. Submitting Changes

  1. Fork the Repository:

    • Click the "Fork" button at the top-right corner of this repository.

  2. Clone Your Fork:

    • Clone your forked repository to your local machine: 
      git clone https://github.com/<your-username>/create-kalp-dapp.git

  3. Create a Branch:

    • Create a new branch for your changes: 
      git checkout -b my-new-feature

  4. Make Your Changes:

    • Make your changes to the code or documentation.

  5. Commit Your Changes:

    • Commit your changes with a descriptive commit message: 
      git add .
git commit -m "Add new feature"

  6. Push Your Changes:

    • Push your changes to your forked repository: 
      git push origin my-new-feature

  7. Create a Pull Request:

    • Go to the original repository and open a pull request from your forked repository.

3. Code Reviews

All submissions, including pull requests, will undergo review. Be prepared to make adjustments based on feedback.

Code Style

Please adhere to these guidelines to maintain consistency:

  • Use clear and descriptive variable names.
  • Comment your code where necessary, especially in complex sections.
  • Follow the coding style already present in the project.
  • For Go code, follow the Effective Go guidelines.
  • For JavaScript/TypeScript, adhere to the ESLint configuration provided in the project.

Kalp DLT Specific Contributions

When contributing features or fixes related to Kalp DLT:

  • Ensure all smart contract interactions are compatible with the latest Kalp DLT SDK.
  • Test your changes thoroughly on the Kalp DLT testnet before submitting.
  • Document any new Kalp DLT-specific features or changes clearly.

Documentation

Improvements to documentation are always welcome. This includes:

  • README updates
  • Inline code comments
  • New guides or tutorials

Contact

If you have any questions or need further clarification, please:

  • Open an issue in the GitHub repository
  • Reach out directly to me though telergam @spydiecy.

Thank you for contributing to Create Kalp Dapp and helping to improve the Kalp DLT ecosystem!