Skip to content

Commit

Permalink
docs(readme): update instructions for creating a new example
Browse files Browse the repository at this point in the history
advises users to create a PR to the github-mgmt repo for their particular example, instead of needing to try to create a repo to an org where contributors may not have permission.

fixes #19
  • Loading branch information
SgtPooki authored Aug 4, 2023
1 parent 1599420 commit ae3c713
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,7 @@ Contributions are what make the open source community such an amazing place to b
1. Create a folder in this repo under `examples`, eg. `./examples/helia-transfer-files`
1. Add the files and tests that make up the example
1. Add the folder name to the `project-list` lists in the `examples` and `push-changes` jobs in this repositories `./github/ci.yml`
1. Fork the [example-template-fork-&-go](https://github.com/ipfs-examples/example-fork-go-template) into the `ipfs-examples` org with the same name as the example folder, e.g. `https://github.com/ipfs-examples/helia-transfer-files`
- Turn off issues/wiki/discussions etc in the new fork
- If you do not have permissions to do this, please say so in the PR you open to `ipfs-examples/helia-examples` and someone will help you
- Set Actions > General > Workflow permissions to "Read and write permissions" if not already
1. Create a PR to https://github.com/ipfs-examples/github-mgmt similar to https://github.com/ipfs-examples/github-mgmt/pull/22 to facilitate the addition of your project as an isolated repo.

#### Examples must

Expand Down

0 comments on commit ae3c713

Please sign in to comment.