Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 7 additions & 110 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,117 +1,14 @@
# Contributing

Thank you for your interest in contributing to example apps for the Internet Computer.
By participating in this project, you agree to abide by our [Code of Conduct](./CODE_OF_CONDUCT.md).
Thank you for your interest in the Internet Computer examples. By participating in this project, you agree to abide by our [Code of Conduct](./CODE_OF_CONDUCT.md).

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.
## Current status: not accepting external pull requests

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.
This repository is maintained by DFINITY. We are currently restructuring the examples to integrate them more closely with the [developer documentation](https://docs.internetcomputer.org), and are **not accepting external pull requests** — neither new examples nor changes to existing ones — during this period. External pull requests may be closed without review.

## Contents of this repository
## Reporting issues

This repository contains example apps built for the Internet Computer by the DFINITY team. The purpose of these example apps is to showcase useful features and use cases of both the Internet Computer and Motoko through sample code and accompanying documentation. It is our hope that these examples help and inspire you to build your own Internet Computer applications.
Bug reports and suggestions are welcome:

## 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](https://forum.dfinity.org/) or submit a [support request](mailto://support@dfinity.org).

- 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 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

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](https://github.com/firstcontributions/first-contributions) or [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/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.

1. Navigate to the DFINITY public repository in a web browser.

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

1. Clone the repository to your local machine.

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

```
git checkout -b my-branch-name-here
```

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

1. 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
```
1. 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."
```

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

```
git push origin my-branch-name-here
```

1. 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.

1. Wait for the pull request to be reviewed.

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

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

## Tips for contributing to example apps

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 example

### Reporting an issue

To open a new issue:

1. Click **Issues**.

1. Click **New Issue**.

1. Click **Open a blank issue**.

1. 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 example

See [ADDING_AN_EXAMPLE.md](./../ADDING_AN_EXAMPLE.md) for guidelines on how to structure and submit a new example.
- Open a [GitHub issue](https://github.com/dfinity/examples/issues). For bugs, include the name of the example, your icp-cli version (`icp --version`), the result you expected, and what happened instead.
- Or post on the [community forum](https://forum.dfinity.org/).
41 changes: 0 additions & 41 deletions .github/workflows/pre-download-launcher.sh

This file was deleted.

83 changes: 0 additions & 83 deletions .github/workflows/provision-darwin.sh

This file was deleted.

84 changes: 0 additions & 84 deletions .github/workflows/provision-linux.sh

This file was deleted.

30 changes: 0 additions & 30 deletions .github/workflows/provision-pocket-ic-server.sh

This file was deleted.

27 changes: 0 additions & 27 deletions .github/workflows/update-dfx-cache.sh

This file was deleted.

Loading
Loading