Skip to content

Latest commit

 

History

History
124 lines (73 loc) · 5.68 KB

CONTRIBUTING.md

File metadata and controls

124 lines (73 loc) · 5.68 KB
Raw

Contributing

Thank you for your interest in contributing to awesome projects and resources relating to DFINITY and the Internet Computer. 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 or share your own projects.

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.

Contents of this repository

This repository contains example apps, libraries, and developer tools built for the Internet Computer by the DFINITY team as well as the Internet Computer developer ecosystem. The purpose of this repository is to provide a curated list of projects and examples, along with sample code and accompanying documentation, to help and inspire you to build your own Internet Computer applications.

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 or request help, click Issues.

    You can also 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, including the name of the example app and SDK version.

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

    • Bugs and errors when compiling the example apps
    • Bugs and errors associated with front-end assets
    • Code improvements
    • Feature requests
    • Adding your own project to the list

    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

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 DFINITY public repository in a web browser.

  3. Click Fork to create a copy 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!

Tips for contributing

Depending on the type of contribution you want to make, you might follow a different workflow. For example, if you are only interested in reporting an issue, there's no need to clone repository or set up a documentation environment.

This section describes the most common workflow scenarios:

  • Reporting an issue
  • Submitting your own project

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

Submitting your own project

The easiest way to include your project in our curated list is to go to https://github.com/dfinity/awesome-dfinity/blob/master/README.md and click on the "edit" icon in the top right-hand corner. Make any edits, adding your project to the appropriate category, and follow the instructions to create a new pull request.

Before adding your project to the list, consider the following:

  1. Will my contribution be valuable to the Internet Computer developer ecosystem?
  2. Does my project contain both code and accompanying documentation?
  3. Please pay attention the appropriate categories and alphabetical ordering, whenever possible.