keeweb/CONTRIBUTING.md

67 lines
3.0 KiB
Markdown
Raw Permalink Normal View History

2017-11-13 23:04:42 +01:00
# Contributing to KeeWeb
Thanks for taking the time to contribute! :gift:
2020-04-18 12:40:10 +02:00
There are different ways to help the project, you will find a summary here.
2017-11-13 23:04:42 +01:00
## Code of conduct
2020-04-18 12:40:10 +02:00
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.
2017-11-13 23:04:42 +01:00
## Issues
First, let's check if it's [already there](https://github.com/keeweb/keeweb/issues).
Perhaps, someone has already reported it?
2020-04-18 12:40:10 +02:00
[Click here](https://github.com/keeweb/keeweb/issues/new/choose) to create a new issue.
2017-11-13 23:04:42 +01:00
When creating issues, please answer some questions asked on that page.
2019-08-18 08:17:32 +02:00
They will help to understand, reproduce, and fix your issue.
2017-11-13 23:04:42 +01:00
2020-04-18 12:48:26 +02:00
## Vulnerabilities
2020-04-18 12:40:10 +02:00
We would appreciate [responsible disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure).
2020-04-18 12:48:57 +02:00
If you would like to report a vulnerability, the preferred way to do so is [contacting the developer directly](mailto:antelle.net@gmail.com).
2020-04-18 12:40:10 +02:00
2017-11-13 23:04:42 +01:00
## Questions, great ideas, etc...
2020-04-18 12:40:10 +02:00
You can [create an issue](https://github.com/keeweb/keeweb/issues/new/choose) to discuss any topic.
2017-11-13 23:04:42 +01:00
Indeed, questions on that page are not applicable in this case.
2020-04-18 12:47:00 +02:00
## Development
2020-04-18 13:11:05 +02:00
We don't accept (and in foreseeable future, we won't accept) anyone as a project collaborator directly.
2020-04-18 12:47:00 +02:00
Instead, the code should be contributed via pull requests. To get started with development, take a look at these pages:
- [Architecture](https://github.com/keeweb/keeweb/wiki/Architecture)
- [Engineering](https://github.com/keeweb/keeweb/wiki/Engineering)
2020-04-18 12:47:28 +02:00
- [Unsupported Features](https://github.com/keeweb/keeweb/wiki/Unsupported%20Features)
2020-04-18 12:47:00 +02:00
- [Pull Request Guidelines](https://github.com/keeweb/keeweb/blob/master/.github/PULL_REQUEST_TEMPLATE.md#readme)
2017-11-13 23:04:42 +01:00
## Pull requests
Please follow [this guide](https://github.com/keeweb/keeweb/blob/master/.github/PULL_REQUEST_TEMPLATE.md#readme).
2017-11-13 23:09:09 +01:00
## Docs (Wiki pages)
KeeWeb has [Wiki pages](https://github.com/keeweb/keeweb/wiki), however it's not possible to contribute with pull requests.
2020-04-18 12:40:10 +02:00
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
2020-04-18 12:56:18 +02:00
All KeeWeb translations are contributed by the community. To improve a translation or add a missing one,
2020-04-18 12:59:09 +02:00
join us on [OneSky](https://keeweb.oneskyapp.com).
2020-04-18 12:53:05 +02:00
## PR
We would be happy to support you if you decide to post, blog, or review the project,
2020-04-18 12:53:30 +02:00
or provide any other kind of PR. Please [contact the developer](mailto:antelle.net@gmail.com)
2020-04-18 12:53:05 +02:00
if you have anything to share. You can also poke us on [Twitter](https://twitter.com/kee_web).