CONTRIBUTING.md

Contributing

Thank you for your interest in contributing to this repo. 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.

All contributions to DFINITY documentation and the developer community are respected and appreciated. Your participation is an important factor in the success of the Internet Computer.

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 a general question, 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 crate, the version of the code you are using, the results you expected, and how the actual results differed from your expectations.

Submitting a pull request

If you want to submit a pull request to fix an issue or add a feature, here's a summary of what you need to do:

1. Make sure you have a GitHub account, an internet connection, and access to a terminal shell or GitHub Desktop application for running commands.

2. Navigate to the official repository in a web browser.

3. Click Fork to create a copy of the repository associated with the issue you want to address under your GitHub account or organization name.

4. Clone the repository to your local machine.

5. Create a new branch for your fix by running a command similar to the following:

   git checkout -b my-branch-name-here

6. Open the file you want to fix in a text editor and make the appropriate changes for the issue you are trying to address.

7. Add the file contents of the changed files to the index git uses to manage the state of the project by running a command similar to the following:

   git add path-to-changed-file

8. Commit your changes to store the contents you added to the index along with a descriptive message by running a command similar to the following:

   git commit -m "Description of the fix being committed."

9. Push the changes to the remote repository by running a command similar to the following:

   git push origin my-branch-name-here

10. Create a new pull request for the branch you pushed to the upstream GitHub repository.

    Provide a title that includes a short description of the changes made.

11. Wait for the pull request to be reviewed.

12. Make changes to the pull request, if requested.

13. Celebrate your success after your pull request is merged!