Skip to content

Latest commit

 

History

History
23 lines (14 loc) · 992 Bytes

CONTRIBUTING.md

File metadata and controls

23 lines (14 loc) · 992 Bytes

How to contribute

First of all, thank you for taking the time to contribute to this project. I have tried to make fun project to collect Ciphers

Writing some code!

Contributing to a project on Github is pretty straight forward. If this is you're first time, these are the steps you should take.

Be sure to create a new directory for each cipher that is added. I am hoping to keep this somewhat organized.

Claim an issue
Fork this repo
Code up a Cipher
Add documentation about the cipher
Write a couple tests (Test encoding and decoding messages)
Profit

And that's it! You're change should not break the existing code and should pass the tests.

If you're adding a new functionality, start from the branch main. It would be a better practice to create a new branch and work in there.

When you're done, submit a pull request and for one of the maintainers to check it out. We would let you know if there is any problem or any changes that should be considered.