From 773864758e62ad0fd28139519b98986d9e8091dd Mon Sep 17 00:00:00 2001 From: David Dias Date: Mon, 30 Jul 2018 06:21:16 -0700 Subject: [PATCH 1/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d6f09a5..724deae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,18 +2,26 @@ Please ensure your pull request adheres to the following guidelines: +### 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. + +### 2. Creating a submission + - Make an individual pull request for each suggestion. - 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. -- The pull request should have a useful title and include a link to the package and why it should be included. -- Submit products when they are useable, or at a state which has something to show which is awesome in itself. This cuts down on half-finished implementations. - Add the idea to the corresponding file on [`data`](./data) and make sure it matches the format. - You can add a picture to describe your idea on [`./src/static/images`](./src/static/images). + +### 3. Submitting it through a PR + - Make sure to run `npm run build:readme` or `yarn build:readme` before submitting the Pull Request. +- The pull request should have a useful title and include a link to the package and why it should be included. +- Submit products when they are useable, or at a state which has something to show which is awesome in itself. This cuts down on half-finished implementations. Thank you for your suggestions! From bf8e653e7b9b3631fd1fb3fd35a48e0444fcdedb Mon Sep 17 00:00:00 2001 From: Henrique Dias Date: Mon, 30 Jul 2018 22:17:24 +0100 Subject: [PATCH 2/2] fix commit 3eacf7 --- README.md | 3 +-- scripts/readme-template.md | 21 ++++++++------------- 2 files changed, 9 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 0d782b1..cd2543f 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,7 @@ > Useful resources for using [IPFS](https://ipfs.io) and building things on top of it -_This list is for projects, tools, or pretty much any things related to IPFS that are totally_ **awesome**_. This is for products which are already awesome - if you have plans for cool stuff to do with IPFS, you should build it, and then -link it here. If you have an idea for an awesome thing to do with IPFS, a good place to ask about it might be in [ipfs/apps](https://github.com/ipfs/apps) or [ipfs/notes](https://github.com/ipfs/notes)._ +_This list is for projects, tools, or pretty much any things related to IPFS that are totally_ **awesome**_. This is for products which are already awesome - if you have plans for cool stuff to do with IPFS, you should build it, and then link it here. If you have an idea for an awesome thing to do with IPFS, a good place to ask about it might be in [ipfs/apps](https://github.com/ipfs/apps) or [ipfs/notes](https://github.com/ipfs/notes)._ ## Table of Contents diff --git a/scripts/readme-template.md b/scripts/readme-template.md index 5d01c82..6a73ea5 100644 --- a/scripts/readme-template.md +++ b/scripts/readme-template.md @@ -6,32 +6,27 @@ > Useful resources for using [IPFS](https://ipfs.io) and building things on top of it -_This list is for projects, tools, or pretty much any things related to IPFS that -are totally_ **awesome**_. This is for products which are already awesome - if -you have plans for cool stuff to do with IPFS, you should build it, and then -link it here. If you have an idea for an awesome thing to do with IPFS, a good -place to ask about it might be in [ipfs/apps](https://github.com/ipfs/apps) or -[ipfs/notes](https://github.com/ipfs/notes)._ +_This list is for projects, tools, or pretty much any things related to IPFS that are totally_ **awesome**_. This is for products which are already awesome - if you have plans for cool stuff to do with IPFS, you should build it, and then link it here. If you have an idea for an awesome thing to do with IPFS, a good place to ask about it might be in [ipfs/apps](https://github.com/ipfs/apps) or [ipfs/notes](https://github.com/ipfs/notes)._ ## Table of Contents +- [Contribute](#contribute-to-this-list) #PLACEHOLDER_TOC# - [Discussions](#discussions) -- [Contribute](#contribute) - - [Want to hack on IPFS?](#want-to-hack-on-ipfs) +- [Want to hack on IPFS?](#want-to-hack-on-ipfs) - [License](#license) +## Contribute to this list! + +Everyone is welcome to submit their new awesome-ipfs item. Check the [CONTRIBUTING.md guidelines](https://github.com/ipfs/awesome-ipfs/blob/master/CONTRIBUTING.md) to learn how to do so. + #PLACEHOLDER_CATEGORIES# ## Discussions * [CRDTs discussion](https://github.com/ipfs/notes/issues/23) -## Contribute - -Please add (or remove) stuff from this list if you see anything awesome! [Open an issue](https://github.com/ipfs/awesome-ipfs/issues) or a PR. - -### Want to hack on IPFS? +## Want to hack on IPFS? [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)