Skip to content

Latest commit

 

History

History
70 lines (43 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

70 lines (43 loc) · 2.8 KB

Contributing to eth-data-library

🎉 Thank you for considering contributing to the Ethereum Data Library! 🎉

The Ethereum Data Library is open to contributions from the community to improve functionality, fix issues, or add new features. By contributing, you help make Ethereum development more accessible and efficient for everyone.

How to Contribute

To contribute to the Ethereum Data Library, follow these steps:

  1. Fork the Repository: Start by forking the eth-data-library repository on GitHub.

  2. Clone the Repository: Clone your forked repository to your local machine.

    git clone https://github.com/mrnazu/eth-data-library.git
cd eth-data-library

  3. Install Dependencies: Make sure you have Node.js and npm installed. Install the project dependencies.

    npm install

  4. Create a Branch: Create a new branch for your contribution.

    git checkout -b feature/new-feature

    Choose a branch name that reflects the nature of your contribution (e.g., feature/new-feature, fix/issue-description).

  5. Make Changes: Implement your changes or additions. Ensure that your code follows the existing code style and conventions.

  6. Run Tests: Before committing your changes, run the tests to ensure everything is working correctly.

    npm test

  7. Commit Changes: Commit your changes with a descriptive commit message that explains the purpose of your changes.

    git commit -am 'Add new feature: description'

  8. Push Changes: Push your changes to your forked repository.

    git push origin feature/new-feature

  9. Create Pull Request: Go to the Ethereum Data Library repository on GitHub. You should see a prompt to create a pull request from your recently pushed branch. Fill out the pull request template with details about your changes.

  10. Review and Merge: Once submitted, your pull request will be reviewed by the maintainers. Address any feedback or comments and work towards getting your changes merged into the main repository.

Code Style

  • Follow consistent coding style and conventions used throughout the project.
  • Maintain clear and descriptive variable and function names.
  • Use meaningful comments where necessary to explain complex logic or functionality.

Reporting Issues

If you encounter any bugs, issues, or have suggestions for improvements, please open an issue on GitHub. Provide detailed information about the problem and steps to reproduce it.

License

By contributing to the Ethereum Data Library, you agree that your contributions will be licensed under the MIT License.