Skip to content

Latest commit

 

History

History
59 lines (32 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

59 lines (32 loc) · 2.49 KB
Raw

Contributing

By participating in this project, you agree to abide by our Code of Conduct.

As a member of the community, you are invited and encouraged to contribute by submitting issues, offering suggestions for improvements, adding review comments to existing pull requests, or creating new pull requests to fix issues.

Contents of this repository

This repository contains a collection of libraries and tools for building software around the Internet Computer, in Rust.

Before you contribute

Before contributing, please take a few minutes to review these contributor guidelines. The contributor guidelines are intended to make the contribution process easy and effective for everyone involved in addressing your issue, assessing changes, and finalizing your pull requests.

Before contributing, consider the following:

  • If you want to report an issue, click Issues.

  • If you have more general questions related to Motoko and its use, post a message to the community forum or submit a support request.

  • If you are reporting a bug, provide as much information about the problem as possible.

  • If you want to contribute directly to this repository, typical fixes might include any of the following:

    • Fixes to resolve bugs or documentation errors
    • Code improvements
    • Feature requests

    Note that any contribution to this repository must be submitted in the form of a pull request.

  • If you are creating a pull request, be sure that the pull request only implements one fix or suggestion.

If you are new to working with GitHub repositories and creating pull requests, consider exploring First Contributions or How to Contribute to an Open Source Project on GitHub.

How to make a contribution

Depending on the type of contribution you want to make, you might follow different workflows.

This section describes the most common workflow scenarios:

  • Reporting an issue
  • Submitting a pull request

Reporting an issue

To open a new issue:

  1. Click Issues.

  2. Click New Issue.

  3. Click Open a blank issue.

  4. Type a title and description, then click Submit new issue.

    Be as clear and descriptive as possible.

    For any problem, describe it in detail, including details about the library, the version of the code you are using, the result