diff --git a/contribute.html b/contribute.html index 4a8e98e..144b688 100644 --- a/contribute.html +++ b/contribute.html @@ -19,82 +19,10 @@

Contributing to the KeyStore Explorer Project

How Can I Contribute?

-

To make it easier for users who would like to get involved and help us improve KSE, this section contains suggestions and - guidelines on how to contribute.

+

To make it easier for users who would like to get involved and help us improve KSE, there is a contribution guide in the + KSE GitHub project: Contribution Guide

-

Reporting Bugs

- -

One of the best ways you can help us improve KSE is to let us know about any problems you find with it.

- -

The KSE project uses GitHub issues to report and track issues.

- -

Before you file an issue, search for it to see if anyone has already reported it. If you find your issue, check if you - can provide additional information, that might be useful to resolve the issue.

- -

If no one has reported your bug, file the bug. Please describe the problem in detail. Be sure to include: -

-

- -

In general, put as much information in bugs as you can. The more detail you provide, the more likely your issue is to be resolved.

- -

Important: Please be on the lookout for any follow-up questions we may have.

- -

Contributing to the Code

- -

If you want to contribute to the code, go to GitHub, fork the KSE repository, apply your changes and open a - pull request (PR). GitHub provides detailed information on the process on their website: -

-

- GitHub - Contributing to a Project -

- -

In order to make the review of the PR a pleasant experience for contributors and reviewers and - to preserve the quality of the code base, it is important to: -

-

- -

If you intend to implement a non-trivial enhancement or a new feature, please make sure there is a - issue that corresponds to your contribution - – either created by you or by somebody else. Announce in the issue that you intend to work on it - to make sure that the work is not done twice. This is also a good way to get some guidance on how - to beste tackle a problem or discuss implementation ideas.

- -

Contributing to the Documentation or Website

- -

Good documentation is crucial for any kind of software. You can help improving the documentation: -

-

- -

Translations

- -

You are welcome to translate the KSE application or documentation into your own language. Just create a - issue where you announce that you want to - work on translating KSE in a certain language.

- -

Spread the Word

- -

If you like KSE, why not recommend it to your friends, colleagues or blog followers? - Mention it in your blog, on twitter, in forums, on StackOverflow...

+

The contribution guide covers not only code contributions but also bug reports, translations and contributions to the documentation.

List of Contributions