Skip to content

Latest commit

 

History

History
92 lines (57 loc) · 3.4 KB

CONTRIBUTING.md

File metadata and controls

92 lines (57 loc) · 3.4 KB
Raw

Contributing to int64-node

Thank you for your interest in contributing to int64-node! We welcome contributions from the community to help make this library even better. Please take a moment to review this guide for contributing.

Table of Contents

Code of Conduct

Please note that this project is governed by the int64-node Code of Conduct. By participating in this project, you agree to abide by its terms.

How to Contribute

We appreciate contributions in the form of bug reports, feature requests, documentation improvements, and code contributions. Here's how you can get started:

  1. Fork the Repository: Click the "Fork" button on the top right corner of the repository's page to create your fork.

  2. Clone Your Fork: Clone your forked repository to your local machine.

    git clone https://github.com/pb2204/int64-node.git
cd int64-node

  3. Create a Branch: Before making any changes, create a new branch to work on your feature or bug fix.

    git checkout -b my-feature-branch

  4. Make Changes: Implement your changes. Be sure to follow the project's coding style and guidelines.

  5. Commit Changes: Commit your changes with a clear and concise commit message.

    git commit -m "Add new feature" # Use an appropriate commit message

  6. Push to Your Fork: Push your changes to your forked repository on GitHub.

    git push origin my-feature-branch

  7. Create a Pull Request: Go to the original int64-node repository on GitHub, and click the "New Pull Request" button. Describe your changes and submit your pull request.

We will review your pull request as soon as possible and provide feedback. Thank you for contributing!

Reporting Issues

If you encounter any issues with int64-node or have a suggestion for improvement, please open an issue on the GitHub Issue Tracker. When reporting issues, please provide as much detail as possible, including the version of int64-node, your Node.js version, and any relevant code samples or error messages.

Submitting Pull Requests

When submitting a pull request, please ensure the following:

  • Your code adheres to the project's coding style and guidelines.
  • Your changes are well-documented, including comments where necessary.
  • You have tested your changes to ensure they work as expected.

Development Setup

If you want to set up int64-node for development, follow these steps:

  1. Clone the repository as described in the "How to Contribute" section.
  2. Install dependencies by running npm install.
  3. You can then start working on your changes and run tests (if applicable).

Testing

To run tests for int64-node, you can use the following command:

npm test

Please make sure your changes pass all existing tests and consider adding new tests if your contribution includes new functionality.

License

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

Thank you for your contributions and support in making int64-node better!

Happy Coding 🚀