Skip to content

Latest commit

 

History

History
103 lines (67 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

103 lines (67 loc) · 3.01 KB
Raw

Contributing to ntfs-undelete

Welcome to ntfs-undelete! We are excited to have you contribute to our project. By following this guide, you can help us improve the library and make it even better.

Table of Contents

  1. Introduction
  2. Getting Started
  3. Making Changes
  4. Testing
  5. Submitting Pull Requests
  6. Contact
  7. Acknowledgments

Introduction

ntfs-undelete is a binary for recovering deleted files from NTFS.

We welcome contributions from everyone, whether you're a seasoned developer or just getting started with open-source. You can contribute in many ways, such as:

  • Fixing bugs
  • Adding new features
  • Improving documentation
  • Enhancing test coverage
  • Reporting issues
  • Providing feedback

Getting Started

To get started with contributing to ntfs-undelete, follow the steps below:

Fork the Repository

Click the "Fork" button at the top right corner of the repository to create your own fork.

Clone the Repository

Clone your forked repository to your local development environment:

git clone https://github.com/your-username/ntfs-undelete.git
cd ntfs-undelete

Replace your-username with your GitHub username.

Making Changes

Now you can make changes to the codebase. Follow these best practices:

  • Create a new branch for each contribution:
git checkout -b your-branch-name
  • Write clear and concise commit messages.
  • Make atomic commits for logically separate changes.
  • Make sure your code is formatted according to the project's style guidelines.
cargo clippy

Testing

We highly value the quality of our codebase, and tests play a crucial role in ensuring that quality. Before submitting your changes, run the test suite:

cargo test

Make sure all tests pass successfully.

Submitting Pull Requests

Once you've made the necessary changes and ensured the tests pass, it's time to submit your contribution:

  1. Push your changes to your forked repository:
git push origin your-branch-name
  1. Go to the GitHub repository page for ntfs-undelete.
  2. Click on the "Pull Requests" tab and then click "New Pull Request."
  3. Select your branch from the dropdown and provide a descriptive title and summary of your changes.
  4. If your pull request addresses any issues, reference them using the following syntax: "Fixes #issue_number."
  5. Submit the pull request, and it will be reviewed by our team.

Contact

If you have any questions or need further assistance, you can reach out to us via the following channels:

Acknowledgments

I would like to express our gratitude to all contributors who help make ntfs-undelete better with their valuable contributions.

Thank you for being a part of our community and happy contributing!