Skip to content

Commit

Permalink
removed redundancy for contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
@kaikramer
kaikramer committed Apr 7, 2024
1 parent 80139f6 commit e72034a
Showing 1 changed file with 3 additions and 75 deletions.
78 changes: 3 additions & 75 deletions contribute.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,82 +19,10 @@ <h1>Contributing to the KeyStore Explorer Project<a></a></h1>

<h2>How Can I Contribute?</h2>

<p>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.</p>
<p>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: <a href="https://github.com/kaikramer/keystore-explorer/blob/main/CONTRIBUTING.md">Contribution Guide</a> </p>

<h3>Reporting Bugs</h3>

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

<p>The KSE project uses <a href="https://github.com/kaikramer/keystore-explorer/issues">GitHub issues</a> to report and track issues.</p>

<p>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.</p>

<p>If no one has reported your bug, file the bug. Please describe the problem in detail. Be sure to include:
<ul>
<li>Steps to reproduce the problem.</li>
<li>What happened.</li>
<li>What you think the correct behavior should be.</li>
<li>Don't forget to mention which operating system and which version of Java and KSE you're using.</li>
</ul>
</p>

<p>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.</p>

<p><b>Important:</b> Please be on the lookout for any follow-up questions we may have.</p>

<h3>Contributing to the Code</h3>

<p>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:
</p>
<p>
<a href="https://guides.github.com/activities/contributing-to-open-source/#contributing">GitHub - Contributing to a Project</a>
</p>

<p>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:
<ul>
<li>Make sure the code changes are well tested and that they cause no unwanted side effects.</li>
<li>Verify that all existing and new tests pass.</li>
<li>Check that the code formatting matches the existing code. For IntelliJ IDEA you can
use <a href="kse_formatter.xml">this formatter configuration</a>, for Eclipse you should
at least modify the default formatter so that lines are wrapped at 120 characters and
all indentations are spaces (no tabs).</li>
<li>Make sure no unrelated or unnecessary reformatting changes are included.</li>
</ul>
</p>

<p>If you intend to implement a non-trivial enhancement or a new feature, please make sure there is a
<a href="https://github.com/kaikramer/keystore-explorer/issues">issue</a> that corresponds to your contribution
&ndash; 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. </p>

<h3>Contributing to the Documentation or Website</h3>

<p>Good documentation is crucial for any kind of software. You can help improving the documentation:
<ul>
<li>Please report missing, incorrect, or out-dated documentation as an
<a href="https://github.com/kaikramer/keystore-explorer/issues">issue</a>.</li>
<li>Please open an <a href="https://github.com/kaikramer/keystore-explorer/issues">issue</a>
if you think the website could be improved.</li>
<li>The complete website is hosted in a <a href="https://github.com/kaikramer/kaikramer.github.io">GitHub repository</a>.
Feel free to fork it, improve it and create a pull request.</li>
</ul>
</p>

<h3>Translations</h3>

<p>You are welcome to translate the KSE application or documentation into your own language. Just create a
<a href="https://github.com/kaikramer/keystore-explorer/issues">issue</a> where you announce that you want to
work on translating KSE in a certain language.</p>

<h3>Spread the Word</h3>

<p>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...</p>
<p>The contribution guide covers not only code contributions but also bug reports, translations and contributions to the documentation.</p>

<h2 id="list-of-contributions">List of Contributions</h2>

Expand Down

0 comments on commit e72034a

Please sign in to comment.