Skip to content

Latest commit

 

History

History
89 lines (68 loc) · 3.18 KB

CONTRIBUTE.md

File metadata and controls

89 lines (68 loc) · 3.18 KB

Contributing to CipherCraft

Thank you for considering contributing to CipherCraft! Your contributions are invaluable in making this tool better and more powerful. This document will guide you through the process of contributing to the project.

How to Contribute

1. Fork the Repository

  1. Go to the CipherCrafttGitHub repository.
  2. Click the "Fork" button in the top-right corner of the page.
  3. This will create a copy of the repository in your GitHub account.

2. Clone Your Fork

Clone the repository to your local machine using the following command:

git clone https://github.com/YOUR_USERNAME/ciphercraft.git

Replace YOUR_USERNAME with your GitHub username.

3. Create a Branch

Before making any changes, create a new branch to keep your work isolated:

git checkout -b feature/your-feature-name

Replace your-feature-name with a descriptive name for your branch.

4. Make Your Changes

Now you can start working on your changes! Here are a few ways you can contribute:

  • Bug Fixes: Look for issues tagged with "bug" in the issues section.
  • New Features: Suggest new features or work on features tagged with "enhancement".
  • Documentation: Improve the documentation, fix typos, or clarify explanations.
  • Tests: Write unit tests to ensure that the code remains stable.

5. Test Your Changes

Before submitting your changes, make sure that all tests pass:

python -m unittest discover

Add new tests if you are introducing new functionality.

6. Commit and Push

Once you're happy with your changes, commit them:

git add .
git commit -m "Description of your changes"

Then push your branch to your fork:

git push origin feature/your-feature-name

7. Submit a Pull Request

  • Go to the original CipherCrafttrepository.
  • Click on the "Pull Requests" tab.
  • Click on "New Pull Request".
  • Select your branch from the "compare" dropdown.
  • Provide a detailed description of your changes and click "Create Pull Request".

8. Wait for Feedback

Your pull request will be reviewed by the maintainers. They might request changes or provide feedback. Please be responsive to any comments and make the necessary updates.

Coding Standards

Please follow these coding standards when contributing:

  • Python Code Style: Follow PEP 8 for Python code.
  • Commit Messages: Use clear and descriptive commit messages.
  • Documentation: Ensure that new functions and classes are well-documented with docstrings.

Reporting Issues

If you find a bug or have a feature request, please report it in the issues section of the repository. Be sure to include:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Expected and actual behavior.
  • Any relevant screenshots or code snippets.

Community Guidelines

Please be respectful and considerate to others when contributing or interacting with the community. Follow the principles of open communication and collaboration.

License

By contributing to CipherCraft, you agree that your contributions will be licensed under the Apache License 2.0.

Contact

For any questions, feel free to reach out to the maintainer: