Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (45 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

73 lines (45 loc) · 2.91 KB

CONTRIBUTING.md

Introduction

Thank you for considering contributing to the SpecDec project! This repository is dedicated to advancing the field of machine unlearning for large language models (LLMs). We appreciate your interest and contributions, which help improve the project and expand its capabilities.

How You Can Help

There are many ways you can contribute to the SpecDec project:

  1. Bug Reports: If you encounter any bugs, please report them using the issue tracker. Be sure to include detailed information and steps to reproduce the issue.

  2. Feature Requests: Suggest new features or enhancements by opening an issue. We welcome ideas that can improve the project.

  3. Code Contributions: Submit pull requests to fix bugs, add features, or improve documentation. Please ensure your code follows the project's coding standards.

  4. Documentation: Help improve the documentation by suggesting edits or adding new content to clarify usage and features.

  5. Testing: Write tests to ensure the reliability and stability of the codebase.

Getting Started

To start contributing, follow these steps:

  1. Fork the Repository: Create a personal copy of the repository by forking it.

  2. Clone the Repository: Clone your forked repository to your local machine.

    git clone https://github.com/Ebay/spec_dec.git

  3. Install Dependencies: Navigate to the project's root directory and install the required dependencies using the requirements.txt file.

    pip install -r requirements.txt

Making Changes

  1. Create a Branch: Before making changes, create a new branch for your work.

    git checkout -b feature-or-bugfix-name

  2. Implement Changes: Make your changes in the appropriate files or directories.

  3. Test Your Changes: Ensure that your changes do not break existing functionality. Add tests if necessary.

  4. Commit Your Changes: Commit your changes with a clear and descriptive message.

    git commit -m "Add feature or fix bug: description"

  5. Push Your Branch: Push your branch to your forked repository.

    git push origin feature-or-bugfix-name

  6. Create a Pull Request: Navigate to the original repository and create a pull request from your branch. Provide a detailed description of your changes.

Code Style and Guidelines

  • Follow PEP 8 for Python code style.
  • Write clear, concise, and descriptive commit messages.
  • Ensure that your code is well-documented and includes comments where necessary.

Communication

Feel free to reach out to the project maintainers for guidance or clarification. You can use the issue tracker for discussions or send an email if needed.

Thank You!

Thank you for your interest in contributing to SpecDec! Your support is invaluable to the project's success. We look forward to collaborating with you and appreciate your efforts to improve the project.