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
This commit is contained in:
Vince 2018-11-25 20:55:32 +01:00 committed by Samuel Shifterovich
parent d4f50b8968
commit 82e0d4d223
3 changed files with 34 additions and 32 deletions

View File

@ -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))

View File

@ -1,4 +1,4 @@
<!-- PLEASE READ OUR [CONTRIBUTING GUIDELINES](https://github.com/privacytoolsIO/privacytools.io#contributing-guidelines) BEFORE SUBMITTING -->
<!-- PLEASE READ OUR [CONTRIBUTING GUIDELINES](https://github.com/privacytoolsIO/privacytools.io/blob/master/.github/CONTRIBUTING.md) BEFORE SUBMITTING -->
## Description

View File

@ -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