Move contributing guidelines and fix build instructions #620
29
.github/CONTRIBUTING.md
vendored
29
.github/CONTRIBUTING.md
vendored
@ -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))
|
||||||
|
|
||||||
|
30
README.md
30
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.
|
**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
|
## Building
|
||||||
|
|
||||||
1. Install Ruby
|
1. Install Ruby
|
||||||
2. `bundle install`
|
2. `bundle install`
|
||||||
3. `bundle exec jekyll serve` # Live refresh.
|
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
|
# Support privacytools.io
|
||||||
|
|
||||||
- [Donate.](https://privacytoolsio.github.io/privacytools.io/donate.html)
|
- [Donate.](https://privacytoolsio.github.io/privacytools.io/donate.html)
|
||||||
|
Reference in New Issue
Block a user