Skip to content

Latest commit

 

History

History
106 lines (69 loc) · 4.1 KB

CONTRIBUTING.md

File metadata and controls

106 lines (69 loc) · 4.1 KB
Raw

Contributing to Crypto Encryption Project

Thank you for your interest in contributing to the Crypto Encryption Project! We welcome contributions from everyone, whether you're fixing bugs, improving documentation, or adding new features. To ensure a smooth collaboration, please follow the guidelines outlined below.

Getting Started

1. Fork the Repository

Start by forking the repository to your GitHub account. This will create a copy of the project under your own GitHub user.

2. Clone Your Fork

Clone the repository to your local machine to start making changes:

git clone https://github.com/techiuv/crypto-encryption-project.git
cd crypto-encryption-project

3. Create a New Branch

Before you start working, create a new branch for your feature or fix. Branch names should be descriptive of the work being done:

git checkout -b feature-or-fix-name

4. Install Dependencies

If there are any dependencies required, ensure they are installed. Currently, this project requires:

  • GCC for compiling C programs.
  • Bash for running the shell script.

Making Changes

Code Style

Please follow these coding style guidelines when contributing:

  • C Code: Follow common C programming conventions. Keep your code clean and well-commented.
  • Shell Scripts: Use consistent indentation and follow shell scripting best practices.

Adding Features or Fixes

  • Ensure your changes do not break existing functionality.
  • If adding a new feature, consider writing corresponding tests if applicable.
  • Update documentation (e.g., README.md) if your changes affect usage or add new features.

Commit Your Changes

Commit your changes with a clear and descriptive commit message:

git add .
git commit -m "Description of the feature or fix"

Push Your Changes

Push your changes to your forked repository:

git push origin feature-or-fix-name

Submit a Pull Request

Once your changes are pushed to your fork, open a Pull Request (PR) against the main branch of the original repository:

  • Go to the original repository on GitHub.
  • Click on the "New pull request" button.
  • Select the branch you just pushed from your forked repository.
  • Provide a clear title and description for your PR.
  • Submit the pull request

What Happens Next?

After you submit your pull request, it will be reviewed by the maintainers. They may ask for changes or clarification before merging. Once approved, your changes will be merged into the main repository.

Reporting Issues

If you find a bug or have a suggestion, please open an issue on the GitHub Issues page. Include as much detail as possible to help us understand and resolve the issue.

Issue Guidelines

  • Search Existing Issues: Before opening a new issue, please check if someone has already reported the same problem or feature request.
  • Provide Details: Clearly describe the issue, including steps to reproduce, expected behavior, and screenshots if applicable.

Code of Conduct

Please note that this project adheres to a Code of Conduct. By participating in this project, you agree to abide by its terms.

Thank You!

Thank you for taking the time to contribute to the Crypto Encryption Project! Your help is greatly appreciated, and we look forward to your contributions.

Explanation of Sections:

  1. Getting Started: Provides instructions on how to fork, clone, and set up the project locally.
  2. Making Changes: Guidelines on how to code and what to do when adding features or fixing bugs.
  3. Commit and Push: Instructions on committing and pushing changes to the repository.
  4. Submit a Pull Request: Explains the process of submitting your contributions for review.
  5. Reporting Issues: Guidelines on how to report bugs or request features.
  6. Code of Conduct: A reference to the project's code of conduct.
  7. Thank You: A note of appreciation to contributors.

This CONTRIBUTING.md will help standardize contributions, making it easier for maintainers to manage and for contributors to know what's expected of them.