Skip to content

Latest commit

 

History

History
40 lines (23 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

40 lines (23 loc) · 1.77 KB
Raw

Contributing Guidelines

If you're new here, welcome to CrypTools! 🎉

The folowing are the contributing guideleines for all CrypTools projects. Keep in mind that these are guidelines not rules.

Table of Contents

Code of Conduct

The code of conduct is an adapted version of the Contributor Covenant Code of Conduct. CODE_OF_CONDUCT.md

How can I Contribute?

Found a Bug?

If you have found a bug in one of our ciphers, you can open an issue to signal the bug. Here are a couple of simple steps to create a good issue:

  • Use a clear title. You should be able to guess what the issue is just by reading the title
  • Describe how to reproduce the problem. Give a step by step detailed explanation of how to reproduce the bug.
  • What did you observe? Tell us what behaviour you saw.
  • What did you expect? Tell us what you expected as an output.

If you know how to fix the bug, please open a pull request including your fix. Please read the bullet list below to make a good pull request.

Found a way to improve our code?

If you have found some ineficient code that you can improve, please go ahead and open a pull request including your improvements. Here are a couple of of steps to make a good pull request:

  • Use a clear title. You should be able to guess what the issue is just by reading the title.
  • What was wrong? Describe what was not optimal in the original code.
  • How can it be improved/fixed? Describe the changes you would like to submit in as much detail as you can.