Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

49 lines (32 loc) · 2.67 KB

Contributing to Cryptogrammer

Welcome to Cryptogrammer! We appreciate your interest in contributing to this project. Whether you want to fix a typo, add content, or improve existing code, your contributions are valuable. Please take a moment to read this guide to understand how you can contribute.

Table of Contents

How to Contribute

Reporting Bugs

If you encounter a bug or an issue with Cryptogrammer, please help us by reporting it. To report a bug, follow these steps:

  1. Ensure the bug has not already been reported by checking the Issues section of this repository.
  2. If the issue doesn't exist, open a new issue and provide a clear and detailed description of the problem, including any error messages or steps to reproduce the issue.

Suggesting Enhancements

We welcome suggestions for enhancing Cryptogrammer. To suggest an enhancement, follow these steps:

  1. Check the Issues section to see if the enhancement has been suggested before.
  2. If not, open a new issue and describe your proposed enhancement in detail. Be clear about why it would be valuable.

Code Contributions

If you want to contribute code to Cryptogrammer, we'd love your help! Here's how you can do it:

  1. Fork the repository to your GitHub account.
  2. Create a new branch for your changes: git checkout -b feature/your-feature-name.
  3. Make your code changes, ensuring that your code follows the project's coding style and conventions.
  4. Write tests for your code changes where applicable.
  5. Commit your changes with clear, concise commit messages.
  6. Push your changes to your fork: git push origin feature/your-feature-name.
  7. Create a pull request (PR) from your branch to the main branch of this repository.

Getting Started

If you're new to contributing to open source projects, you can start by:

  • Finding an issue labeled as "good first issue" in the Issues section.
  • Reading through the project's code and documentation to familiarize yourself with the project.
  • Joining our community discussions and asking questions if you need help.

Thank you for your interest in contributing to Cryptogrammer! Your contributions help make this project better for everyone.