From cee56750c1b841e2cda4765a81b1d0ad9d2259d5 Mon Sep 17 00:00:00 2001 From: Vincevrp Date: Sun, 25 Nov 2018 20:31:56 +0100 Subject: [PATCH 1/4] Move contributing guidelines to CONTRIBUTING.md --- .github/CONTRIBUTING.md | 29 ++++++++++++++++++++++++++++- README.md | 30 ++---------------------------- 2 files changed, 30 insertions(+), 29 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index be7c6aa6..f60cd2d5 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1 +1,28 @@ -Please refer to the **Contributing** and **Contributing Guidelines** sections of our [readme](https://github.com/privacytoolsIO/privacytools.io/blob/master/README.md) for the most up-to-date guidelines. Thank you. +# Contributing Guidelines + +Please read this before contributing. + +## Rules + +- Be nice and respectful. +- English only. +- Be constructive. + +## Quality over Quantity + +We're trying to keep it simple and promote the best tools, not all of them. Maximum are three software choices, but it's possible to add more under "Worth Mentioning" headlines. ([example](https://privacytoolsio.github.io/privacytools.io/#im)) + +## Software Criteria + +- Open Source +- Cross-platform +- Easy to use +- Privacy respecting + +There can be exceptions if no software is available that meet the criteria. + +## Images + +- Provider logos should be exactly 200 x 70 ([example](https://www.privacytools.io/assets/img/provider/AirVPN.gif)) +- Tool logos should be exactly 120 x 120 ([example](https://www.privacytools.io/assets/img/tools/ChatSecure.png)) + diff --git a/README.md b/README.md index 2602deef..612af63d 100644 --- a/README.md +++ b/README.md @@ -8,40 +8,14 @@ It's important for a website like privacytools.io to be up-to-date. Keep an eye **Talk to us please.** Join our [subreddit](https://www.reddit.com/r/privacytoolsIO/) and start a discussion. This is a community project and we're aiming to deliver the best information available for a better privacy. We are also using [/r/privacy](https://www.reddit.com/r/privacy). Thank you for participating. -You can submit your suggestions here on GitHub [(Issues)](https://github.com/privacytoolsIO/privacytools.io/issues) and also in our [subreddit](https://www.reddit.com/r/privacytoolsIO/). Thank you. +You can submit your suggestions here on GitHub [(Issues)](https://github.com/privacytoolsIO/privacytools.io/issues) and also in our [subreddit](https://www.reddit.com/r/privacytoolsIO/). Please refer to the [Contributing Guidelines](.github/CONTRIBUTING.md) for the most up-to-date guidelines. Thank you. ## Building + 1. Install Ruby 2. `bundle install` 3. `bundle exec jekyll serve` # Live refresh. -# Contributing Guidelines -Please read this before contributing. - -## Rules - -- Be nice and respectful. -- English only. -- Be constructive. - -## Quality over Quantity - -We're trying to keep it simple and promote the best tools, not all of them. Maximum are three software choices, but it's possible to add more under "Worth Mentioning" headlines. ([example](https://privacytoolsio.github.io/privacytools.io/#im)) - -## Software Criteria - -- Open Source -- Cross-platform -- Easy to use -- Privacy respecting - -There can be exceptions if no software is available that meet the criteria. - -## Images - -- Provider logos should be exactly 200 x 70 ([example](https://www.privacytools.io/assets/img/provider/AirVPN.gif)) -- Tool logos should be exactly 120 x 120 ([example](https://www.privacytools.io/assets/img/tools/ChatSecure.png)) - # Support privacytools.io - [Donate.](https://privacytoolsio.github.io/privacytools.io/donate.html) -- 2.47.2 From 72a8df88bf701f0ec79038e7d91cda1fabc52e10 Mon Sep 17 00:00:00 2001 From: Vincevrp Date: Sun, 25 Nov 2018 20:36:53 +0100 Subject: [PATCH 2/4] Update build instructions --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 612af63d..6b92f85f 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,10 @@ You can submit your suggestions here on GitHub [(Issues)](https://github.com/pri ## Building -1. Install Ruby -2. `bundle install` -3. `bundle exec jekyll serve` # Live refresh. +1. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) +1. Install [bundler](https://bundler.io/) by running `gem install bundler`. +1. Run `bundle install` to install the required dependencies. +1. Use `bundle exec jekyll build` to build the website. The output can be found in the `_site` directory. Live preview is also possible by running `bundle exec jekyll serve` # Support privacytools.io -- 2.47.2 From 112be3eebac58fd1a75b3d41ce20cdf8410a4fdd Mon Sep 17 00:00:00 2001 From: Vincevrp Date: Sun, 25 Nov 2018 20:40:02 +0100 Subject: [PATCH 3/4] Update PR template for new contributing guidelines --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 90ea4e33..e2c31e15 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ - + ## Description -- 2.47.2 From 39b66ea024c8d3352976885e252c2d2a5288de88 Mon Sep 17 00:00:00 2001 From: Vincevrp Date: Sun, 25 Nov 2018 20:49:56 +0100 Subject: [PATCH 4/4] Fix contributing guidelines reference in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6b92f85f..e3f2af9a 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ It's important for a website like privacytools.io to be up-to-date. Keep an eye **Talk to us please.** Join our [subreddit](https://www.reddit.com/r/privacytoolsIO/) and start a discussion. This is a community project and we're aiming to deliver the best information available for a better privacy. We are also using [/r/privacy](https://www.reddit.com/r/privacy). Thank you for participating. -You can submit your suggestions here on GitHub [(Issues)](https://github.com/privacytoolsIO/privacytools.io/issues) and also in our [subreddit](https://www.reddit.com/r/privacytoolsIO/). Please refer to the [Contributing Guidelines](.github/CONTRIBUTING.md) for the most up-to-date guidelines. Thank you. +You can submit your suggestions here on GitHub [(Issues)](https://github.com/privacytoolsIO/privacytools.io/issues) and also in our [subreddit](https://www.reddit.com/r/privacytoolsIO/). Please refer to the [Contributing Guidelines](.github/CONTRIBUTING.md) before submitting. Thank you. ## Building -- 2.47.2