Contribution

Contributing to Cryptography 101

We're thrilled that you're interested in contributing to Cryptography101! This guide will help you get started with contributing to our open-source project.

Ways to Contribute

There are many ways to contribute to Cryptography101:

  1. Content Creation: Write new tutorials, explanations, or case studies.
  2. Content Improvement: Enhance existing content for clarity, accuracy, or depth.
  3. Code Examples: Develop or improve interactive examples and simulations.
  4. Bug Fixes: Help identify and fix issues in our platform or content.
  5. Feature Development: Contribute to new features for the Cryptography101 platform.
  6. Documentation: Improve our contributor guidelines, READMEs, or other documentation.
  7. Translations: Help make Cryptography101 accessible in multiple languages.

Getting Started

  1. Fork the Repository: Start by forking the Cryptography101 repository on GitHub.
  2. Clone Your Fork: Clone your fork to your local machine.
  3. Set Up the Development Environment: Follow our setup guide in the README.
  4. Choose an Issue: Look for open issues labeled "good first issue" or "help wanted".
  5. Create a Branch: Make a new branch for your contribution.
  6. Make Your Changes: Implement your contribution, adhering to our style guide.
  7. Test Your Changes: Ensure your changes don't break existing functionality.
  8. Commit and Push: Commit your changes and push to your fork.
  9. Open a Pull Request: Submit a pull request with a clear description of your changes.

Best Practices

  • Follow the Style Guide: Maintain consistency with our existing content and code.
  • Write Clear Commit Messages: Use descriptive commit messages that explain your changes.
  • Keep Pull Requests Focused: Each PR should address a single issue or feature.
  • Be Respectful: Treat other contributors with respect and kindness.
  • Ask for Help: Don't hesitate to ask questions if you're unsure about anything.

Code of Conduct

We are committed to providing a welcoming and inspiring community for all. Please read and adhere to our Code of Conduct.

Recognition

All contributors will be acknowledged. We deeply appreciate your efforts to improve Cryptography101!

Questions?

If you have any questions about contributing, please open an issue or reach out to our maintainers.

Thank you for helping make Cryptography101 a valuable resource for the cryptography community!

Basics