Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (47 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

68 lines (47 loc) · 3 KB

Contributing to node-abieos

Thank you for considering contributing to the node-abieos project! We welcome contributions from the community to help improve and maintain this project. This document provides guidelines and information for contributing to the project.

How to Contribute

Reporting Issues

If you encounter any issues or bugs while using node-abieos, please report them by creating a new issue in the GitHub issue tracker. When reporting an issue, please provide as much detail as possible, including:

  • A clear and descriptive title
  • A detailed description of the issue
  • Steps to reproduce the issue
  • Any relevant error messages or logs
  • Your environment (e.g., operating system, Node.js version)

Submitting Pull Requests

We welcome pull requests for bug fixes, new features, and improvements. To submit a pull request, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your changes: 
    git checkout -b my-feature-branch
  4. Make your changes and commit them with clear and descriptive commit messages.
  5. Push your changes to your forked repository: 
    git push origin my-feature-branch
  6. Create a pull request on the main repository, providing a clear and descriptive title and description of your changes.

Coding Standards

To ensure consistency and maintainability, please adhere to the following coding standards when contributing to node-abieos:

  • Follow the existing code style and conventions.
  • Write clear and concise code with appropriate comments.
  • Ensure that your code is well-documented.
  • Write unit tests for new features and bug fixes.
  • Run the existing tests to ensure that your changes do not introduce any regressions.

Development Process

The development process for node-abieos follows these general steps:

  1. Fork and Clone: Fork the repository on GitHub and clone it to your local machine.
  2. Create a Branch: Create a new branch for your changes.
  3. Make Changes: Make your changes, following the coding standards and guidelines.
  4. Test: Write and run tests to ensure the correctness of your changes.
  5. Commit: Commit your changes with clear and descriptive commit messages.
  6. Push: Push your changes to your forked repository.
  7. Pull Request: Create a pull request on the main repository.

Code of Conduct

We expect all contributors to adhere to the Code of Conduct to ensure a welcoming and inclusive environment for everyone.

Getting Help

If you need help or have any questions about contributing to node-abieos, feel free to reach out by creating a new issue in the GitHub issue tracker or by joining our community discussions.

Thank you for your contributions and support!

License

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