Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (42 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

62 lines (42 loc) · 1.64 KB

Contributing to WinDropper

Thank you for your interest in contributing to WinDropper! We welcome contributions from everyone.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your forked repository to your local machine
  3. Create a new branch for your feature or bug fix
  4. Make your changes and commit them with clear, descriptive messages
  5. Push your changes to your GitHub repository
  6. Submit a Pull Request

Development Environment

To set up your development environment:

# Install dependencies
npm install

# Start development mode
npm run dev

See the README.md for more detailed development instructions.

Coding Guidelines

  • Follow the existing code style
  • Write TypeScript with proper typing
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep your changes focused on a single issue/feature

Submitting Pull Requests

When submitting a Pull Request:

  1. Update the README.md with details of changes to the interface, if applicable
  2. Include a clear description of the changes made
  3. Reference any related issues
  4. Update documentation as needed
  5. Ensure your code works across different Windows versions

Reporting Bugs

Please use the Bug Report template when reporting bugs. Include as much information as possible, including:

  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Screenshots if applicable
  • Your operating system and WinDropper version

Feature Requests

We welcome feature requests! Please use the Feature Request template to suggest new features.

Questions

If you have any questions, feel free to open an issue with the "question" label.