diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 146d5e3..64663dc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,26 +1,34 @@ # Contribution Guidelines +Thanks for submitting your entry to Awesome IPFS! Please ensure your pull request adheres to the following guidelines: +## Content Policy + +Entries are accepted if they meet the following criteria: + +- Entries must use _IPFS_ +- Entries in the **apps** & **tools** categories must be **open-source** and contain a link to their source code. +- Entries must be immediately usable (eg. nothing that is paywall-only, even a free trial would be ok) +- Entries must have a clear license and/or privacy policy where applicable +- Entries must respect the [IPFS Community Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md) + ### 1. Before submitting - Search previous suggestions before making a new one, as yours may be a duplicate. - If you just created something, wait at least a couple of weeks before submitting. -- Review the [content policy](POLICY.md) to ensure your submission meets the requirements. +- Review the [content policy](#content-policy) to ensure your submission meets the requirements. ### 2. Creating a submission -Make an individual pull request for each suggestion: -- **Do not edit README directly!** -- Add the idea to the corresponding file in [`data`](./data) and make sure it matches the format. +Make an **individual pull request for each suggestion**: Style tips: -- New categories, or improvements to the existing categorization are welcome. + - Keep descriptions short and simple, but descriptive. - Don't mention `IPFS` in the description as it's implied. - Start the description with a capital and end with a full stop/period. - Check your spelling and grammar. -- You can add a picture to describe your idea in [`./src/static/images`](./src/static/images). ### 3. Submitting it through a PR @@ -29,6 +37,4 @@ Style tips: Thank you for your suggestions! ------ - -**NOTE**: If you want to edit the README file directly (not the items/links) you need to modify the [`scripts/readme-template.md`](https://github.com/ipfs/awesome-ipfs/blob/master/scripts/readme-template.md) instead. Thank you! +--- diff --git a/POLICY.md b/POLICY.md deleted file mode 100644 index 3c2b3df..0000000 --- a/POLICY.md +++ /dev/null @@ -1,13 +0,0 @@ -# Awesome IPFS Content Policy - -Thanks for submitting your entry to Awesome IPFS! - -Entries are accepted if they meet the following criteria: - -* Entries must respect the [IPFS Community Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md) -* Entries must use *IPFS* (libp2p, ipld, multiformats is not enough) -* Entries in the **apps** & **tools** categories must be **open-source** and contain a link to their source code. -* Entries must be immediately usable (eg. nothing that is paywall-only, even a free trial would be ok) -* Entries must have a clear license and/or privacy policy where applicable - -This policy is evaluated by the site admins upon submission, per the process defined in the [contribution guide](CONTRIBUTING.md) diff --git a/README.md b/README.md index a7a1fe4..c4bf01e 100644 --- a/README.md +++ b/README.md @@ -44,43 +44,40 @@ If you have an idea for an awesome thing to do with IPFS, a good place to ask ab - [galacteek](https://github.com/pinnaculum/galacteek) - A multi-platform Qt5-based browser for the distributed web. - [gatsby-plugin-ipfs](https://github.com/moxystudio/gatsby-plugin-ipfs) - Adds support for deploying Gatsby websites to IPFS by ensuring that assets are relative. - [git-ipfs-rehost](https://github.com/whyrusleeping/git-ipfs-rehost) - A script to rehost your git repos in ipfs. -- [git-remote-ipfs](https://github.com/cryptix/git-remote-ipfs) - push/pull repositories from/to IPFS +- [git-remote-ipfs](https://github.com/cryptix/git-remote-ipfs) - push/pull repositories from/to IPFS. - [Git IPFS Remote Bridge](https://github.com/ElettraSciComp/Git-IPFS-Remote-Bridge) - set of programs written in Python 3 which allow Git user to clone, push, fetch, self-host or release Git repositories over IPFS decentralized data storage system. - [go-orbit-db](https://github.com/berty/go-orbit-db) - This is a Golang port of OrbitDB that intends to be fully compatible with the original JavaScript version. OrbitDB is a serverless, distributed, peer-to-peer database. -- [gomobile-ipfs](https://github.com/ipfs-shipyard/gomobile-ipfs) - IPFS and libp2p on Mobile, with Gomobile +- [gomobile-ipfs](https://github.com/ipfs-shipyard/gomobile-ipfs) - IPFS and libp2p on Mobile, with Gomobile. - [http2ipfs](https://github.com/jbenet/http2ipfs-web) - This is a simple webtool to add URLs to an IPFS node. -- [IPDR](https://github.com/miguelmota/ipdr) - IPFS-backed Docker Registry -- [IPFS Setup Action](https://github.com/marketplace/actions/ipfs-setup-action) - A GitHub Action to install and initialize go-ipfs to provision a cross-platform test environment on GitHub's CI platform. [Source](https://github.com/ibnesayeed/setup-ipfs) +- [IPDR](https://github.com/miguelmota/ipdr) - IPFS-backed Docker Registry. +- [IPFS Setup Action](https://github.com/ibnesayeed/setup-ipfs) - A GitHub Action to install and initialize go-ipfs to provision a cross-platform test environment on GitHub's CI platform. - [ipfs-action](https://github.com/aquiladev/ipfs-action) - GitHub Action for delivery of static websites. -- [ipfs-add-from-encrypted](https://github.com/TroyWilson1/ipfs-add-from-encrypted) - Encrypt a file or directory with AES256 then add to IPFS +- [ipfs-add-from-encrypted](https://github.com/TroyWilson1/ipfs-add-from-encrypted) - Encrypt a file or directory with AES256 then add to IPFS. - [ipfs-companion](https://github.com/ipfs/ipfs-companion) - Browser extension that simplifies access to IPFS resources. - [ipfs-deploy](https://github.com/agentofuser/ipfs-deploy) - Zero-config CLI to deploy static websites: cd my-static-website && npx @agentofuser/ipfs-deploy - [ipfs-encrypted-share](https://github.com/whs/ipfs-encrypted-share) - Easy to use encrypted file uploader. -- [ipfs-gui](https://github.com/marcin212/ipfs-gui) - Windows UI integration and IPFS installer -- [ipfs-mount](https://github.com/richardschneider/net-ipfs-mount) - Mount IPFS as a mapped drive on Windows -- [ipfs-paste](https://github.com/jbenet/ipfs-paste) - Paste stdin and clipboard to IPFS +- [ipfs-mount](https://github.com/richardschneider/net-ipfs-mount) - Mount IPFS as a mapped drive on Windows. +- [ipfs-paste](https://github.com/jbenet/ipfs-paste) - Paste stdin and clipboard to IPFS. - [ipfs-pinner](https://github.com/wabarc/ipfs-pinner) - A toolkit help upload files to IPFS pinning services. - [ipfs-publish](https://github.com/auhau/ipfs-publish/) - Continuous Delivery tool for delivery of static websites from Git providers to IPFS. - [ipfs-screencap](https://github.com/jbenet/ipfs-screencap) - Capture screenshots, publish them to IPFS, and copy the link to the clipboard. - [ipfs-video-gateway](https://github.com/bneijt/ipfs-video-gateway) - Cloud-init your own IPFS gateway on a cloud provider and easily pin content through a simple web interface. -- [ipfsecret](https://github.com/shlemph/ipfsecret) - Encrypt and decrypt IPFS files with a secret passphrase +- [ipfsecret](https://github.com/shlemph/ipfsecret) - Encrypt and decrypt IPFS files with a secret passphrase. - [ipget](https://github.com/ipfs/ipget) - :satellite: wget for IPFS: retrieve files over IPFS and save them locally. -- [IPLD Explorer](https://github.com/ipfs-shipyard/ipld-explorer) - Explore the Merkle Forest from the comfort of your browser +- [IPLD Explorer](https://github.com/ipfs-shipyard/ipld-explorer) - Explore the Merkle Forest from the comfort of your browser. - [ipns-pin](https://github.com/justicenode/node-ipns-pin) - A command-line tool to pin stuff via ipns. - [IPRedirect](https://github.com/JayBrown/IPRedirect) - Browser userscript for redirecting IPFS/IPNS addresses to your local gateway. This should work on any browser that hasn't had an extension written for it yet and has support for userscripts. - [iprfc](https://github.com/RTradeLtd/iprfc) - IETF RFC downloader which stores RFCs on IPFS and indexes them with RTradeLtd/Lens. -- [ipscend](https://github.com/diasdavid/ipscend) - Tool for hosting web apps and static websites in IPFS - [mahuta](https://github.com/ConsenSys/Mahuta) - Mahuta is a plug and play service for your micro-service architecture allowing to collect, store and index data on IPFS and offering search functionalities (full text, query). - [Multiverse](https://github.com/multiverse-vcs/go-multiverse) - Multiverse is a decentralized version control system that enables peer-to-peer software development. - [orbit-db](https://github.com/orbitdb/orbit-db) - OrbitDB is a serverless, distributed, peer-to-peer database that uses IPFS as its data storage and IPFS Pubsub to automatically sync databases with peers. -- [pinbot](https://github.com/whyrusleeping/pinbot) - Pin content via IRC -- [Public Gateway Checker](https://github.com/ipfs/public-gateway-checker) - Checks which public gateways are online or not +- [Public Gateway Checker](https://github.com/ipfs/public-gateway-checker) - Checks which public gateways are online or not. - [rivet](https://github.com/wabarc/rivet) - A toolkit makes it easier to archive webpages to IPFS. - [SimpleAsWater Bot](https://github.com/simpleaswater/twitter-pinbot) - A twitter bot that adds, pins, unpins your tweets to public IPFS network using IPFS Cluster. - [solid-ipfs](https://github.com/Eximua/solid-ipfs) - Using Solid to store IPFS Hash privately or publicly. -- [Sweet IPFS](https://github.com/RHazDev/Sweet-IPFS) - Full node for Android -- [Tellit](https://gitlab.com/terceranexus6/tellit) - Encrypt files before uploading them using a keypair or a passphrase -- [VIPFS](https://github.com/Ideea-inc/vipfs) - Publish your Vue apps easily to IPFS +- [Sweet IPFS](https://github.com/RHazDev/Sweet-IPFS) - Full node for Android. +- [Tellit](https://gitlab.com/terceranexus6/tellit) - Encrypt files before uploading them using a keypair or a passphrase. +- [VIPFS](https://github.com/Ideea-inc/vipfs) - Publish your Vue apps easily to IPFS. - [wbipfs](https://github.com/wabarc/wbipfs) - A command-line tool and Go package interface for wayback webpage to IPFS. - [youtube2ipfs](https://github.com/dokterbob/youtube2ipfs) - Download videos from YouTube (and similar video platforms) and add them to IPFS. @@ -95,7 +92,9 @@ If you have an idea for an awesome thing to do with IPFS, a good place to ask ab ## Contribute -Everyone is welcome to submit their new awesome-ipfs item, but it will be accepted only if it meets our [**content policy**](./POLICY.md). +Contributions are welcome! + +See the [**Contribution Guidelines**](./CONTRIBUTING.md). ## License diff --git a/pull_request_template.md b/pull_request_template.md index 0496291..feae820 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -1,51 +1,5 @@ -## What kind of PR is this? -**Select only one** *to speed up review/approval; i.e., don't lump an addition and a removal into a single PR.* - -- [ ] **Adding** something new to awesome-ipfs -- [ ] **Editing** something already listed on awesome-ipfs -- [ ] **Removing** something from awesome-ipfs -- [ ] **Something else** *(if so, please explain in the "Additional details" section below)* - - - ## Pre-submit checklist -**Please confirm ALL of the following** before submitting your PR. - [ ] This PR includes only one addition, removal, or edit. -- [ ] I edited the `/data` directory instead of the [README.md](https://github.com/ipfs/awesome-ipfs/blob/master/README.md). -- [ ] I reviewed the [content policy](https://github.com/ipfs/awesome-ipfs/blob/master/POLICY.md) and the and the [IPFS Community Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md) to ensure my submission meets the requirements. -- [ ] I have followed the [CONTRIBUTING.md guidelines](https://github.com/ipfs/awesome-ipfs/blob/master/CONTRIBUTING.md). - -## Additional details - -### Is there anything else we should know about this PR? - - -### For new additions: What is your project's *current* size/reach? - - -### For new additions: What is your project's *potential* size/reach? - - -### For new additions: How critical is IPFS to your project? - -- [ ] Essential -- [ ] Somewhat critical -- [ ] Useful, but not critical - -### For new additions: What core goal(s) does your project address? - -- [ ] Big-data solutions -- [ ] Freedom from corporate/government interference -- [ ] Data integrity -- [ ] Dev tools or other ways to enable developers -- [ ] Disaster resilience/recovery -- [ ] File storage/retrieval -- [ ] File streaming -- [ ] Permanent archiving -- [ ] Self-sovereign identity -- [ ] Platforms that utilize consensus, reputation, or incentivization -- [ ] Other *(please list)* - -### Is anything about IPFS blocking your project? - +- [ ] I have followed the [Contribution Guidelines](https://github.com/ipfs/awesome-ipfs/blob/master/CONTRIBUTING.md). +- [ ] I reviewed the [IPFS Community Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md) to ensure my submission meets the requirements.