From 82e0d4d22388db84ae9e452b9ed10b4da411fd43 Mon Sep 17 00:00:00 2001 From: Vince Date: Sun, 25 Nov 2018 20:55:32 +0100 Subject: [PATCH] Move contributing guidelines and fix build instructions (#620) * Move contributing guidelines to CONTRIBUTING.md * Update build instructions * Update PR template for new contributing guidelines * Fix contributing guidelines reference in README --- .github/CONTRIBUTING.md | 29 +++++++++++++++++++++++++- .github/PULL_REQUEST_TEMPLATE.md | 2 +- README.md | 35 +++++--------------------------- 3 files changed, 34 insertions(+), 32 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/.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 diff --git a/README.md b/README.md index 2602deef..e3f2af9a 100644 --- a/README.md +++ b/README.md @@ -8,39 +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) before submitting. 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)) +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