Skip to content

Latest commit

 

History

History
41 lines (21 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

41 lines (21 loc) · 3.03 KB

Contributing Guidelines

Thank you for considering contributing to our project! We welcome contributions from everyone, whether it's filing a bug report, submitting a feature request, or creating a pull request. Your involvement helps to make this project better for everyone.

NOTE: PLEASE GO THROUGH THE README FILE FOR THE DEATILS OF THE PROJECT.

Bug Reports and Feature Requests

If you encounter any bugs or have ideas for new features, please open an issue on GitHub. When creating an issue, please provide as much detail as possible, including steps to reproduce for bugs and a clear description for feature requests.

Pull Requests

We appreciate your interest in contributing code to this project! To ensure a smooth process, please follow these guidelines when submitting a pull request:

  1. Fork the Repository: If you haven't already, fork the repository to your GitHub account and create a new branch for your changes.

  2. Make Your Changes: Implement your changes or additions to the project. Please ensure your code follows the project's coding standards and conventions.

  3. Test Your Changes: Before submitting your pull request, test your changes thoroughly to ensure they work as intended. If applicable, update any relevant documentation or tests.

  4. Submit Your Pull Request: Once your changes are ready, submit a pull request to the main branch of the original repository. Provide a clear description of your changes, including any relevant context or motivation.

  5. Review Process: Your pull request will undergo review by project maintainers. They may request additional changes or provide feedback before merging your changes into the main codebase.

  6. Continuous Integration: Your pull request will be automatically tested using continuous integration tools. Please ensure all tests pass before requesting a review.

  7. Be Patient and Responsive: Be patient during the review process and respond promptly to any feedback or requests for changes. Collaboration and communication are key to successful contributions.

Frontend Contributions

If you are interested in contributing only to the frontend, you can work on it by having a minimum requirement of a MetaMask wallet. While you won't be able to interact fully with the project's functionality without adding Sepolia Ethers, you'll still be able to work on the UI components.

Blockchain Contributions

For blockchain contributions, you'll need to familiarize yourself with Solidity and the Ethereum blockchain. You can suggest some code changes that provide better efficiency with the same outputs.

Code of Conduct

Please note that by contributing to this project, you agree to abide by the project's Code of Conduct. We expect all contributors to uphold these standards of behavior and create a positive and inclusive community.

Thank you for your interest in contributing to our project! If you have any questions or need assistance, feel free to reach out to the project maintainers.