Skip to content

Latest commit

 

History

History
57 lines (42 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

57 lines (42 loc) · 2.13 KB

Contributing to @butility/network

I welcome contributions from everyone and appreciate your effort in making this project better.

Table of Contents

Ways to Contribute

There are several ways to contribute to this project:

  • Reporting Bugs: If you find a bug, please open an issue and provide as much detail as possible.
  • Feature Requests: We welcome suggestions for new features or improvements.
  • Code Contributions: Feel free to submit code changes, improvements, or bug fixes.
  • Documentation: Help us improve our documentation by submitting edits or additional information.

Getting Started

  1. Fork the Repository: Click the "Fork" button at the top right corner of the page to create your own copy of the repository.
  2. Clone Your Fork: Clone your forked repository to your local machine:
    git clone https://github.com/butility/network.git
  3. Create a Branch: Create a new branch for your work:
    git checkout -b feature/your-feature-name

Submitting a Pull Request

  1. Make Your Changes: Implement your changes or new features.
  2. Commit Your Changes: Write clear, concise commit messages:
    git commit -m "Add feature: your-feature-name"
  3. Push to Your Branch: Push your changes back to your fork:
    git push origin feature/your-feature-name
  4. Open a Pull Request: Go to the original repository and click on "New Pull Request". Provide a clear description of your changes and why they should be merged.

Reporting Issues

If you encounter a bug or have a suggestion, please open an issue on the Issues page. Be sure to include relevant details such as:

  • A description of the problem
  • Steps to reproduce the issue
  • Any relevant screenshots or error messages

License

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