From 152fcccf6038136fa2da9a2db8b863de5d168c8d Mon Sep 17 00:00:00 2001 From: antelle Date: Sat, 18 Apr 2020 12:40:10 +0200 Subject: [PATCH] contributing --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index de6ca45a..02df08cd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,22 +2,30 @@ Thanks for taking the time to contribute! :gift: +There are different ways to help the project, you will find a summary here. + ## Code of conduct -This project and everyone participating in it is governed by the [KeeWeb Code of Conduct](https://github.com/keeweb/keeweb/blob/master/.github/CODE_OF_CONDUCT.md#readme). By participating, you are expected to uphold this code. Please report unacceptable behavior to antelle.net@gmail.com. +This project and everyone participating in it is governed by the [KeeWeb Code of Conduct](https://github.com/keeweb/keeweb/blob/master/.github/CODE_OF_CONDUCT.md#readme). +By participating, you are expected to uphold this code. Please report unacceptable behavior to antelle.net@gmail.com. ## Issues First, let's check if it's [already there](https://github.com/keeweb/keeweb/issues). Perhaps, someone has already reported it? -[Click here](https://github.com/keeweb/keeweb/issues/new) to create a new issue. +[Click here](https://github.com/keeweb/keeweb/issues/new/choose) to create a new issue. When creating issues, please answer some questions asked on that page. They will help to understand, reproduce, and fix your issue. +## Reporting vulnerabilities + +We would appreciate [responsible disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure). +If you would like to report a vulnerability, the preferred way to do so is [contacting the developer directly](antelle.net@gmail.com). + ## Questions, great ideas, etc... -You can [create an issue](https://github.com/keeweb/keeweb/issues/new) to discuss any question. +You can [create an issue](https://github.com/keeweb/keeweb/issues/new/choose) to discuss any topic. Indeed, questions on that page are not applicable in this case. ## Pull requests @@ -27,4 +35,17 @@ Please follow [this guide](https://github.com/keeweb/keeweb/blob/master/.github/ ## Docs (Wiki pages) KeeWeb has [Wiki pages](https://github.com/keeweb/keeweb/wiki), however it's not possible to contribute with pull requests. -If you would like to improve it, please [open an issue](https://github.com/keeweb/keeweb/issues/new) and submit your changes in Markdown format. +If you would like to improve it, please [open an issue](https://github.com/keeweb/keeweb/issues/new/choose) and submit your changes in Markdown format. + +## Donations + +There are two ways of donating: +- join as backer on [OpenCollective](https://opencollective.com/keeweb#support); +- sponsor the developer directly on [GitHub](https://github.com/sponsors/antelle). + +Please note: donation does not imply any type of service contract. + +## Translations + +All of KeeWeb translations are contributed by community. To improve a translation or add a missing one, +join our project on [OneSky](https://keeweb.oneskyapp.com).